Inheritance diagram for Aria2CPP:

Public Member Functions
	Aria2CPP (const char host, const char port, std::string secret="")

std::shared_ptr< Options >	getOptions () 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< URI >	getUris (std::string gid) const

std::vector< Download >	getDownloads (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)

Protected Member Functions
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
std::unique_ptr< HttpClient >	m_httpclient

std::shared_ptr< StubClient >	m_client

std::shared_ptr< Options >	m_options

std::vector< Download >	m_downloads

std::string	m_secret = "token:"

bool	m_hasSecret

Constructor & Destructor Documentation

◆ Aria2CPP()

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

Constructor for Aria2CPP.

Parameters

[in]	host	The full URL of the host.
[in]	port	The port number to connect to.

Example.

Aria2CPP aria("http://localhost","6060");

Aria2CPP

Definition: aria2cpp.h:46

Exceptions

Aria2CPPException

Member Function Documentation

◆ addDownload() [1/2]

std::string Aria2CPP::addDownload	(	const std::string	URI,
		DownloadOptions &	options,
		int	position = `0`
	)

Add a new download from a URI/URL

Parameters

[in]	URI	URI/URL of the download
[in]	DownloadOptions	to use for this download.
[in]	position	Integer starting from 0. The new download will be inserted at that position. If not specified, the download will be added at the end of the queue. [optional]

Returns: The GID of the newly added download.

Return values

[""]	Failed to add addDownload("ftp://ftp.cdrom.com/pub/pictures/mouse.gif"); Aria2CPP::addDownload std::string addDownload(const std::string URI, int position=0) Definition: aria2cpp.cpp:91

Exceptions

Aria2CPPException

◆ addDownload() [2/2]

std::string Aria2CPP::addDownload	(	const std::string	URI,
		int	position = `0`
	)

Add a new download from a URI/URL

Parameters

[in]	URI	URI/URL of the download
[in]	position	Integer starting from 0. The new download will be inserted at that position. If not specified, the download will be added at the end of the queue. [optional]

Returns: The GID of the newly added download.

Return values

[""]	Failed to add addDownload("ftp://ftp.cdrom.com/pub/pictures/mouse.gif");

Exceptions

Aria2CPPException

◆ addJsonValueToDownloads()

void Aria2CPP::addJsonValueToDownloads	(	Json::Value	downloads,
		bool	getPeers = `true`,
		bool	getServers = `true`
	)

protected

Translate Json::Value to a vector of Download() objects.

This method takes the Json::Value results from getWaitingDownloads(). getActiveDownloads() and getWaitingStopped() and populates the downloads vector by adding the downloads.

Parameters

[in]	downloads	Json::Value results results.
[in]	getPeers	Retrieve the list of peers if a torrent. Defaults to true.
[in]	getServers	Retrieve the list of servers. Defaults to true.

Exceptions

Aria2CPPException

◆ addMetalink() [1/2]

stringList Aria2CPP::addMetalink	(	const std::string	metalinkFile,
		DownloadOptions &	dopts,
		int	position = `0`
	)

Add a Metalink download

Parameters

[in]	metalinkFile	Path to a .metalink file.
[in]	position	Integer starting from 0. The new download will be inserted at that position. If not specified, the download will be added at the end of the queue. [optional]

If position is given, it must be an integer starting from 0. The new download will be inserted at that position. If position is omitted it is added to the end of the queue.

Returns: An array of GIDs of the newly added downloads.

Return values

[""]	Failed to add

Exceptions

Aria2CPPException

◆ addMetalink() [2/2]

stringList Aria2CPP::addMetalink	(	const std::string	metalinkFile,
		int	position = `0`
	)

Add a Metalink download

Parameters

[in] torretFile Path to a .metalink file.

Returns: The GID of the newly added download.

Parameters

[in] position Integer starting from 0. The new download will be inserted at that position. If not specified, the download will be added at the end of the queue. [optional]

Returns: An array of GIDs of the newly added downloads.

Return values

[""]	Failed to add

Exceptions

Aria2CPPException

◆ addTorrent() [1/2]

std::string Aria2CPP::addTorrent	(	const std::string	torrentFile,
		DownloadOptions &	options,
		stringList	URIs = `stringList{}`,
		int	position = `0`
	)

Add a new BitTorrent download

Parameters

[in]	Path	to a .torrent file.
[in]	DownloadOptions	to use for this download.
[in]	URIs	URIs of a BitTorrent Magnet URIs. [optional]
[in]	position	Integer starting from 0. The new download will be inserted at that position. If not specified, the download will be added at the end of the queue. [optional]

Returns: The GID of the newly added download.

Return values

[""]	Failed to add addTorrent("/home/user/debian11.torrent", debopts); Aria2CPP::addTorrent std::string addTorrent(const std::string torrentFile, DownloadOptions &options, stringList URIs=stringList{}, int position=0) Definition: aria2cpp.cpp:122

Exceptions

Aria2CPPException

◆ addTorrent() [2/2]

std::string Aria2CPP::addTorrent	(	const std::string	torrentFile,
		stringList	URIs = `stringList{}`,
		int	position = `0`
	)

Add a new BitTorrent download

Parameters

[in]	torrentFile	Path to a .torrent file.
[in]	URIs	URI of a BitTorrent Magnet URI. [optional]
[in]	position	Integer starting from 0. The new download will be inserted at that position. If not specified, the download will be added at the end of the queue. [optional]

Returns: The GID of the newly added download.

Return values

[""]	Failed to add addTorrent("/home/user/debian11.torrent", debopts);

Exceptions

Aria2CPPException

◆ changePosition()

int Aria2CPP::changePosition	(	const std::string	gid,
		const int	count,
		std::string	how
	)		const

Change the position of the download denoted by the string GID.

Parameters

[in]	gid	The GID of the download to remove.
[in]	count	New position of string.
[in]	how	How to move string (refer to aria2c man page for methods).

Returns: New position of download.

Exceptions

Aria2CPPException

◆ forceRemove()

bool Aria2CPP::forceRemove ( const std::string gid ) const

Remove the download from the queue by force. This does not remove the downloaded file(s). This works the same as Aria2CPP::remove() but does not perform actions which take time, such as contacting BitTorrent trackers to unregister the download first.

Parameters

[in] gid The GID of the download to remove.

Return values

[true]	Download successfully removed.
[false]	Removal failed.

Exceptions

Aria2CPPException

◆ forceShutdown()

bool Aria2CPP::forceShutdown ( ) const

Shutdown the aria2 daemon. This works the same as Aria2CPP::shutdown() but does not perform actions which take time, such as contacting BitTorrent trackers to unregister the download first. After the daemon has shut down there will not be an active connection anymore and this class should be destroyed.

Returns: Success status.

Return values

[true]	Downloads succesfully resumed.
[false]	Error resuming.

Exceptions

Aria2CPPException

◆ getActiveDownloads()

Json::Value Aria2CPP::getActiveDownloads ( stringList keys = stringList() ) const

protected

Fetch all active downloads.

Parameters

[in] keys Optional stringList vector which contains the keys to return. If ommitted, all keys are returned.

Returns: Json::Value array of all active downloads.

Exceptions

Aria2CPPException

◆ getDownload() [1/2]

Download Aria2CPP::getDownload	(	const size_t	pos,
		stringList	keys = `stringList()`,
		bool	getPeers = `true`,
		bool	getServers = `true`
	)

Retrieve a specific download denoted by its position.

Parameters

[in]	pos	The position number of the download to retreive.
[in]	keys	Optional stringList vector which
[in]	getPeers	Retrieve the list of peers if a torrent. Defaults to true.
[in]	getServers	Retrieve the list of servers. Defaults to true. contains the keys to update (Download data details). If you specify keys, then only that specific information will be present in the downloads details and any other download information will be a default value. Selecting specific keys to update may be useful if you are only interested in some information and want to minimise the data transferred. If omitted, all information about the download is retreived. This is the default.

Returns: The Download specified.

Exceptions

Aria2CPPException

◆ getDownload() [2/2]

Download Aria2CPP::getDownload	(	const std::string	gid,
		stringList	keys = `stringList()`,
		bool	getPeers = `true`,
		bool	getServers = `true`
	)

Retrieve a specific download denoted by GID.

Parameters

[in]	gid	The GID of the download to retreive.
[in]	keys	Optional stringList vector which
[in]	getPeers	Retrieve the list of peers if a torrent. Defaults to true.
[in]	getServers	Retrieve the list of servers. Defaults to true. contains the keys to update (Download data details). If you specify keys, then only that specific information will be present in the downloads details and any other download information will be a default value. Selecting specific keys to update may be useful if you are only interested in some information and want to minimise the data transferred. If omitted, all information about the download is retreived. This is the default.

Returns: The Download specified.

Exceptions

Aria2CPPException

◆ getDownloads()

std::vector< Download > Aria2CPP::getDownloads ( stringList keys = stringList() )

Retrieve a vectors of all the downloads managed by this aria2 instance.

Parameters

[in] keys Optional stringList vector which contains the keys to update (Download data details). If you specify keys, then only that specific information will be present in the downloads details and any other download information will be a default value. Selecting specific keys to update may be useful if you are only interested in some information and want to minimise the data transferred. If omitted, all information about the download is retreived. This is the default.

Returns: A vector of Download's

Exceptions

Aria2CPPException
Aria2CPPException

◆ getGlobalOption()

Options Aria2CPP::getGlobalOption ( ) const

Get the global aria2 options

Returns: An Options class with the global options of aria2.

Exceptions

Aria2CPPException

◆ getGlobalStat()

GlobalStat Aria2CPP::getGlobalStat ( ) const

Get global download statistics.

Returns: GlobalStat struct containing current aria2 statistics.

Exceptions

Aria2CPPException

◆ getOptions()

std::shared_ptr< Options > Aria2CPP::getOptions ( ) const

Get a shared pointer to the Global Options of the current aria2 instance.

Returns: A shared pointer to the Options which contains all current aria2c Options.; A shared pointer to a new Options instance.

Exceptions

Aria2CPPException

◆ getSessionID()

std::string Aria2CPP::getSessionID ( )

Get aria2 session ID. The session ID is generated each time aria2 is invoked. This can be used to differentiate between different aria2 instantiations.

Returns: The session ID.

Exceptions

Aria2CPPException

◆ getUris()

std::vector< URI > Aria2CPP::getUris ( std::string gid ) const

Retrieve list of URI's from a partular download specified by GID.

Parameters

[in] gid The download to retrieve the URI's from.

Returns: Vector of URI's with the relevant URI's.

Exceptions

Aria2CPPException

◆ getVersion()

Version Aria2CPP::getVersion ( ) const

Get aria2 version.

Returns: Version struct. This will contain the version and enabled features.

Exceptions

Aria2CPPException

◆ getWaitingDownloads()

Json::Value Aria2CPP::getWaitingDownloads ( stringList keys = stringList() ) const

protected

Fetch all waiting/paused downloads.

Parameters

[in] keys Optional stringList vector which contains the keys to return. If ommitted, all keys are returned.

Returns: Json::Value array of all waiting/paused downloads.

Exceptions

Aria2CPPException

◆ getWaitingStopped()

Json::Value Aria2CPP::getWaitingStopped ( stringList keys = stringList() ) const

protected

Fetch all stopped downloads.

Parameters

[in] keys Optional stringList vector which contains the keys to return. If ommitted, all keys are returned.

Returns: Json::Value array of all stopped downloads.

Exceptions

Aria2CPPException

◆ gid()

std::string Aria2CPP::gid ( const size_t pos ) const

Fetch the GID of the download at position pos.

Parameters

[in] pos The position of the download to query.

Returns: The GID of the download.

Exceptions

Aria2CPPException

◆ hasGid()

bool Aria2CPP::hasGid ( const std::string gid ) const

Check if this GID corresponds with an existing download. This is useful to check of a particular download still exists.

Parameters

[in] gid The GID to query.

Return values

[true]	A download with this GID exists.
[false]	A download with this GID was not found

Exceptions

Aria2CPPException

◆ listMethods()

stringList Aria2CPP::listMethods ( )

This method returns all the available RPC methods in an array of string.

Returns: Vector of strings containing all the available RPC methods.

Exceptions

Aria2CPPException

◆ name()

std::string Aria2CPP::name ( const size_t pos ) const

Fetch the name of the download at position pos.

Parameters

[in] pos The position of the download to query.

Returns: The name of the download. For a single file, this will be the filename, and for a torrent, the title of the Torrent.

Exceptions

Aria2CPPException

◆ pause()

bool Aria2CPP::pause ( const std::string gid ) const

Pause the download denoted by the string GID.

Returns: Success status.

Return values

[true]	Download succesfully paused.
[false]	Error pausing.

Exceptions

Aria2CPPException

◆ pauseAll()

bool Aria2CPP::pauseAll ( ) const

Pause all active Downloads.

Returns: Success status.

Return values

[true]	Downloads succesfully paused.
[false]	Error pausing.

Exceptions

Aria2CPPException

◆ purgeDownloadResult()

bool Aria2CPP::purgeDownloadResult ( ) const

Purges completed/error/removed downloads to free memory.

Return values

[true]	A download with this GID exists.
[false]	A download with this GID was not found

Exceptions

Aria2CPPException

◆ remove()

bool Aria2CPP::remove ( const std::string gid ) const

Remove the download from the queue. This does not remove the downloaded file(s).

Parameters

[in] gid The GID of the download to remove.

Return values

[true]	Download successfully removed.
[false]	Removal failed.

Exceptions

Aria2CPPException

◆ removeDownloadResult()

bool Aria2CPP::removeDownloadResult ( const std::string gid ) const

Purges a specific completed/error/removed downloads to free memory.

Parameters

[in] gid The GID of the download to purge.

Return values

[true]	A download with this GID exists.
[false]	A download with this GID was not found

Exceptions

Aria2CPPException

◆ resume()

bool Aria2CPP::resume ( const std::string gid ) const

Resume the download denoted by the string GID.

Returns: Success status.

Return values

[true]	Download succesfully resumed.
[false]	Error resuming.

Exceptions

Aria2CPPException

◆ resumeAll()

bool Aria2CPP::resumeAll ( ) const

Resume all paused Downloads.

Returns: Success status.

Return values

[true]	Downloads succesfully resumed.
[false]	Error resuming.

Exceptions

Aria2CPPException

◆ saveSession()

bool Aria2CPP::saveSession ( ) const

Save the aria2 session to the default aria2 save file.

Return values

[true]	Success.
[false]	Failure.

Exceptions

Aria2CPPException

◆ setGlobalOption()

bool Aria2CPP::setGlobalOption	(	const std::string	option,
		const std::string	value
	)

Set a global aria2 option. The options correspond to those in the aria2 manual page. To set an option, pass the string of the aira2 option, and another string of the options value.

Parameters

[in]	option	The option to set.
[in]	value	The value to set the option to. setGlobalOption("dry-run", "true"); // Set aria2 to do dry run of downloads setGlobalOption("file-allocation", "prealloc"); // Set aria2 to preallocate space for downloads. Aria2CPP::setGlobalOption bool setGlobalOption(const std::string option, const std::string value) Definition: aria2cpp.cpp:423

Return values

[true]	Option set successfully.
[false]	Failed to set option.

Exceptions

Aria2CPPException

◆ shutdown()

bool Aria2CPP::shutdown ( ) const

Shutdown the aria2 daemon. After the daemon has shut down there will not be an active connection anymore and this class should be destroyed.

Returns: Success status.

Return values

[true]	Downloads succesfully resumed.
[false]	Error resuming.

Exceptions

Aria2CPPException

◆ tellStatus()

Json::Value Aria2CPP::tellStatus	(	std::string	gid,
		stringList	values = `stringList()`
	)

protected

Fetch all active downloads.

Parameters

[in] keys Optional stringList vector which contains the keys to return. If ommitted, all keys are returned.

Returns: Json::Value array of all active downloads.

Exceptions

Aria2CPPException

◆ update()

void Aria2CPP::update ( stringList keys = stringList() )

Refresh downloads status. This function will recreate the list of downloads based on the current status of aria2. It is recommended to run this anytime you need to query the status of any ongoing downloads.

Parameters

[in] keys Optional stringList vector which contains the keys to update (Download data details). If you specify keys, then only that specific information will be present in the downloads details and any other download information will be a default value. Selecting specific keys to update may be useful if you are only interested in some information and want to minimise the data transferred. If omitted, all information about the download is retreived. This is the default.

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

src/aria2cpp.h
src/aria2cpp.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ Aria2CPP()

Member Function Documentation

◆ addDownload() [1/2]

◆ addDownload() [2/2]

◆ addJsonValueToDownloads()

◆ addMetalink() [1/2]

◆ addMetalink() [2/2]

◆ addTorrent() [1/2]

◆ addTorrent() [2/2]

◆ changePosition()

◆ forceRemove()

◆ forceShutdown()

◆ getActiveDownloads()

◆ getDownload() [1/2]

◆ getDownload() [2/2]

◆ getDownloads()

◆ getGlobalOption()

◆ getGlobalStat()

◆ getOptions()

◆ getSessionID()

◆ getUris()

◆ getVersion()

◆ getWaitingDownloads()

◆ getWaitingStopped()

◆ gid()

◆ hasGid()

◆ listMethods()

◆ name()

◆ pause()

◆ pauseAll()

◆ purgeDownloadResult()

◆ remove()

◆ removeDownloadResult()

◆ resume()

◆ resumeAll()

◆ saveSession()

◆ setGlobalOption()

◆ shutdown()

◆ tellStatus()

◆ update()