Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
mvsim::RemoteResourcesManager Class Reference

#include <RemoteResourcesManager.h>

Inheritance diagram for mvsim::RemoteResourcesManager:
Inheritance graph
[legend]

Public Member Functions

 RemoteResourcesManager ()
 
std::string resolve_path (const std::string &uri)
 
 ~RemoteResourcesManager ()=default
 

Static Public Member Functions

static std::string cache_directory ()
 
static bool is_remote (const std::string &uri)
 
static std::tuple< bool, std::string, std::string > zip_uri_split (const std::string &uri)
 

Private Member Functions

std::string handle_local_zip_package (const std::string &localZipFil, const std::string &internalURI)
 
std::string handle_remote_uri (const std::string &uri)
 

Detailed Description

Keeps a local directory with cached archives and packages from remote servers. The cache directory is $HOME/.cache/mvsim-storage/ in non-Windows systems.

See resolve_path() for the possible formats of URI addresses.

Definition at line 27 of file RemoteResourcesManager.h.

Constructor & Destructor Documentation

◆ RemoteResourcesManager()

RemoteResourcesManager::RemoteResourcesManager ( )

Definition at line 18 of file RemoteResourcesManager.cpp.

◆ ~RemoteResourcesManager()

mvsim::RemoteResourcesManager::~RemoteResourcesManager ( )
default

Member Function Documentation

◆ cache_directory()

std::string RemoteResourcesManager::cache_directory ( )
static

Definition at line 45 of file RemoteResourcesManager.cpp.

◆ handle_local_zip_package()

std::string RemoteResourcesManager::handle_local_zip_package ( const std::string &  localZipFil,
const std::string &  internalURI 
)
private

Returns the local file that internalURI refers to, possibly decompressing the ZIP package first if it is the first time.

Definition at line 148 of file RemoteResourcesManager.cpp.

◆ handle_remote_uri()

std::string RemoteResourcesManager::handle_remote_uri ( const std::string &  uri)
private

Definition at line 73 of file RemoteResourcesManager.cpp.

◆ is_remote()

bool RemoteResourcesManager::is_remote ( const std::string &  uri)
static

Returns true if the URI starts with "http[s]://"

Definition at line 23 of file RemoteResourcesManager.cpp.

◆ resolve_path()

std::string RemoteResourcesManager::resolve_path ( const std::string &  uri)

Processes an URI with the format described next, and returns a local machine URI for that file.

Possible formats for uri:

Definition at line 29 of file RemoteResourcesManager.cpp.

◆ zip_uri_split()

std::tuple< bool, std::string, std::string > RemoteResourcesManager::zip_uri_split ( const std::string &  uri)
static

Returns {true, zip_uri, internal_uri} if the URI refers to a ZIP file, or {false, uri, ""} otherwise.

Definition at line 61 of file RemoteResourcesManager.cpp.


The documentation for this class was generated from the following files:


mvsim
Author(s):
autogenerated on Tue Jul 4 2023 03:08:23