libaria2cpp 0.2.0
Basic CPP library to connect to an ARIA2 daemon via the RPC interface.
Public Member Functions | List of all members
Aria2Ctl Class Reference
Inheritance diagram for Aria2Ctl:
Inheritance graph
[legend]
Collaboration diagram for Aria2Ctl:
Collaboration graph
[legend]

Public Member Functions

bool doOperation (const int operation, const stringList &arglist, DownloadOptions &dopts)
 
 Aria2CPP (const char *host, const char *port, std::string secret="")
 
- Public Member Functions inherited from Aria2CPP
 Aria2CPP (const char *host, const char *port, std::string secret="")
 
std::shared_ptr< OptionsgetOptions () const
 
void update (stringList keys=stringList())
 
std::string addDownload (const std::string URI, int position=0)
 
std::string addDownload (const std::string URI, DownloadOptions &options, int position=0)
 
std::string addTorrent (const std::string torrentFile, DownloadOptions &options, stringList URIs=stringList{}, int position=0)
 
std::string addTorrent (const std::string torrentFile, stringList URIs=stringList{}, int position=0)
 
stringList addMetalink (const std::string metalinkFile, int position=0)
 
stringList addMetalink (const std::string metalinkFile, DownloadOptions &dopts, int position=0)
 
bool pause (const std::string gid) const
 
bool resume (const std::string gid) const
 
bool pauseAll () const
 
bool shutdown () const
 
bool forceShutdown () const
 
bool resumeAll () const
 
bool saveSession () const
 
int changePosition (const std::string gid, const int count, std::string how) const
 
bool remove (const std::string gid) const
 
bool forceRemove (const std::string gid) const
 
std::string name (const size_t pos) const
 
std::string gid (const size_t pos) const
 
bool hasGid (const std::string gid) const
 
bool purgeDownloadResult () const
 
bool removeDownloadResult (const std::string gid) const
 
Options getGlobalOption () const
 
bool setGlobalOption (const std::string option, const std::string value)
 
GlobalStat getGlobalStat () const
 
Version getVersion () const
 
std::string getSessionID ()
 
stringList listMethods ()
 
std::vector< URIgetUris (std::string gid) const
 
std::vector< DownloadgetDownloads (stringList keys=stringList())
 
Download getDownload (const std::string gid, stringList keys=stringList(), bool getPeers=true, bool getServers=true)
 
Download getDownload (const size_t pos, stringList keys=stringList(), bool getPeers=true, bool getServers=true)
 

Additional Inherited Members

- Protected Member Functions inherited from Aria2CPP
Json::Value tellStatus (std::string gid, stringList values=stringList())
 
Json::Value getWaitingDownloads (stringList keys=stringList()) const
 
Json::Value getWaitingStopped (stringList keys=stringList()) const
 
Json::Value getActiveDownloads (stringList keys=stringList()) const
 
void addJsonValueToDownloads (Json::Value downloads, bool getPeers=true, bool getServers=true)
 
- Protected Attributes inherited from Aria2CPP
std::unique_ptr< HttpClient > m_httpclient
 
std::shared_ptr< StubClientm_client
 
std::shared_ptr< Optionsm_options
 
std::vector< Downloadm_downloads
 
std::string m_secret = "token:"
 
bool m_hasSecret
 

Member Function Documentation

◆ Aria2CPP()

Aria2CPP::Aria2CPP ( const char *  host,
const char *  port,
std::string  secret = "" 
)

Constructor for Aria2CPP.

Parameters
[in]hostThe full URL of the host.
[in]portThe port number to connect to.

Example.

Aria2CPP aria("http://localhost","6060");
Definition: aria2cpp.h:46
Exceptions
Aria2CPPException

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