OpenCPN Partial API docs
plugin_cache.h
1 /******************************************************************************
2  *
3  * Project: OpenCPN
4  *
5  ***************************************************************************
6  * Copyright (C) 2019 Alec Leamas *
7  * *
8  * This program is free software; you can redistribute it and/or modify *
9  * it under the terms of the GNU General Public License as published by *
10  * the Free Software Foundation; either version 2 of the License, or *
11  * (at your option) any later version. *
12  * *
13  * This program is distributed in the hope that it will be useful, *
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16  * GNU General Public License for more details. *
17  * *
18  * You should have received a copy of the GNU General Public License *
19  * along with this program; if not, write to the *
20  * Free Software Foundation, Inc., *
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
22  ***************************************************************************
23  */
24 
25 #ifndef PLUGIN_CACHE_H__
26 #define PLUGIN_CACHE_H__
27 
28 #include <string>
29 
30 namespace ocpn {
31 
32 std::string get_basename(const char* path);
33 
35 bool store_metadata(const char* path);
36 
41 std::string lookup_metadata(const char* name = 0);
42 
44 bool store_tarball(const char* path, const char* basename);
45 
50 std::string lookup_tarball(const char* basename);
51 
53 unsigned cache_file_count();
54 
56 unsigned long cache_size();
57 
59 void cache_clear();
60 
61 } // namespace ocpn
62 #endif
Standard, mostly strings utilities.
Definition: ocpn_utils.cpp:41
std::string lookup_tarball(const char *uri)
Get path to tarball in cache for given filename.
std::string lookup_metadata(const char *name)
Get metadata path for a given name defaulting to ocpn-plugins.xml)
void cache_clear()
Remove all files in cache:
unsigned cache_file_count()
Return number of files in cache.
bool store_metadata(const char *path)
Store metadata in metadata cache, return success/fail.
bool store_tarball(const char *path, const char *basename)
Store a tarball in tarball cache, return success/fail.
unsigned long cache_size()
Return total size of files in cache in kbytes.