OXY-SYNC-DIRECTORY 1.0
OXY-SYNC-DIRECTORY Library Documentation
Loading...
Searching...
No Matches
oxy::directory::IPack Struct Referenceabstract

Interface for interacting with the pack service. More...

#include <services.hpp>

Public Member Functions

virtual void download (std::string const &packName, std::string const &destination) const =0
 Downloads a specified pack to a destination path.
virtual std::string get_digest (std::string const &packName) const =0
 Retrieves the digest of a specified pack.
virtual int64_t get_size (std::string const &packName) const =0
 Retrieves the size of a specified pack.
virtual void open (const IConnectionPtr &conn)=0
 Opens a connection to the pack service.
virtual void remove (std::string const &packName) const =0
 Removes a specified pack.
virtual void upload (std::string const &source, std::string const &packName) const =0
 Uploads a specified pack from a source path.

Detailed Description

Interface for interacting with the pack service.

This interface provides methods for opening a connection to the pack service, retrieving pack data, and performing operations such as downloading, uploading, and removing packs.

Member Function Documentation

◆ download()

virtual void oxy::directory::IPack::download ( std::string const & packName,
std::string const & destination ) const
pure virtual

Downloads a specified pack to a destination path.

Parameters
packNameThe name of the pack to download
destinationThe destination path to download the pack to

◆ get_digest()

virtual std::string oxy::directory::IPack::get_digest ( std::string const & packName) const
pure virtual

Retrieves the digest of a specified pack.

Parameters
packNameThe name of the pack to retrieve the digest for
Returns
The digest of the specified pack

◆ get_size()

virtual int64_t oxy::directory::IPack::get_size ( std::string const & packName) const
pure virtual

Retrieves the size of a specified pack.

Parameters
packNameThe name of the pack to retrieve the size for
Returns
The size of the specified pack

◆ open()

virtual void oxy::directory::IPack::open ( const IConnectionPtr & conn)
pure virtual

Opens a connection to the pack service.

Parameters
connA shared pointer to an IConnection interface

◆ remove()

virtual void oxy::directory::IPack::remove ( std::string const & packName) const
pure virtual

Removes a specified pack.

Parameters
packNameThe name of the pack to remove

◆ upload()

virtual void oxy::directory::IPack::upload ( std::string const & source,
std::string const & packName ) const
pure virtual

Uploads a specified pack from a source path.

Parameters
sourceThe source path of the pack to upload
packNameThe name of the pack to upload