HTTP download client. More...

#include <tdme/network/httpclient/HTTPDownloadClient.h>

Collaboration diagram for HTTPDownloadClient:

Public Member Functions
	HTTPDownloadClient ()
	Public constructor. More...

const string &	getUsername ()
	Get username. More...

void	setUsername (const string &username)
	Set username. More...

const string &	getPassword ()
	Get password. More...

void	setPassword (const string &password)
	Set password. More...

const string &	getURL ()
	Get URL. More...

void	setURL (const string &url)
	Set URL. More...

const string &	getFile ()
	Get file to download to. More...

void	setFile (const string &file)
	Set file to download to. More...

void	reset ()
	Reset this HTTP client. More...

void	start ()
	Starts the HTTP download to file. More...

int16_t	getStatusCode ()

const vector< string > &	getResponseHeaders ()

bool	isFinished ()

float	getProgress ()

void	cancel ()
	Cancel a started download. More...

void	join ()
	Wait until underlying thread has finished. More...

Static Public Attributes
static const constexpr int16_t	HTTP_STATUSCODE_OK { 200 }

Private Member Functions
string	createHTTPRequestHeaders (const string &hostName, const string &relativeUrl)
	Create HTTP request headers. More...

uint64_t	parseHTTPResponseHeaders (ifstream &rawResponse, int16_t &httpStatusCode, vector< string > &httpHeader)
	Parse HTTP response headers. More...

Private Attributes
string	url

string	file

string	username

string	password

int16_t	httpStatusCode { -1 }

vector< string >	httpHeader

Thread *	downloadThread { nullptr }

Mutex	downloadThreadMutex

bool	haveHeaders { false }

bool	haveContentSize { false }

uint64_t	headerSize { 0LL }

uint64_t	contentSize { 0LL }

volatile bool	finished { true }

volatile float	progress { 0.0f }

Detailed Description

HTTP download client.

Author: Andreas Drewke

Definition at line 26 of file HTTPDownloadClient.h.

Constructor & Destructor Documentation

◆ HTTPDownloadClient()

HTTPDownloadClient ( )

Public constructor.

Definition at line 51 of file HTTPDownloadClient.cpp.

Member Function Documentation

◆ cancel()

void cancel ( )

Cancel a started download.

Definition at line 268 of file HTTPDownloadClient.cpp.

◆ createHTTPRequestHeaders()

string createHTTPRequestHeaders	(	const string &	hostName,
		const string &	relativeUrl
	)

private

Create HTTP request headers.

Parameters

hostName	host name
relativeUrl	url relative to server root

Definition at line 54 of file HTTPDownloadClient.cpp.

◆ getFile()

const string & getFile ( )

inline

Get file to download to.

Returns: file

Definition at line 123 of file HTTPDownloadClient.h.

◆ getPassword()

const string & getPassword ( )

inline

Get password.

Returns: password

Definition at line 91 of file HTTPDownloadClient.h.

◆ getProgress()

float getProgress ( )

inline

Returns: progress

Definition at line 166 of file HTTPDownloadClient.h.

◆ getResponseHeaders()

const vector< string > & getResponseHeaders ( )

inline

Returns: HTTP response headers

Definition at line 155 of file HTTPDownloadClient.h.

◆ getStatusCode()

int16_t getStatusCode ( )

inline

Returns: HTTP status code

Definition at line 148 of file HTTPDownloadClient.h.

◆ getURL()

const string & getURL ( )

inline

Get URL.

Returns: URL

Definition at line 107 of file HTTPDownloadClient.h.

◆ getUsername()

const string & getUsername ( )

inline

Get username.

Returns: username

Definition at line 75 of file HTTPDownloadClient.h.

◆ isFinished()

bool isFinished ( )

inline

Definition at line 159 of file HTTPDownloadClient.h.

◆ join()

void join ( )

Wait until underlying thread has finished.

Definition at line 274 of file HTTPDownloadClient.cpp.

◆ parseHTTPResponseHeaders()

uint64_t parseHTTPResponseHeaders	(	ifstream &	rawResponse,
		int16_t &	httpStatusCode,
		vector< string > &	httpHeader
	)

private

Parse HTTP response headers.

Parameters

rawResponse	raw response
httpStatusCode	HTTP status code
httpHeader	HTTP header

Returns: http header size or 0 if not yet completely submitted

Definition at line 70 of file HTTPDownloadClient.cpp.

◆ reset()

void reset ( )

Reset this HTTP client.

Definition at line 108 of file HTTPDownloadClient.cpp.

◆ setFile()

void setFile ( const string & file )

inline

Set file to download to.

Parameters

file file

Definition at line 131 of file HTTPDownloadClient.h.

◆ setPassword()

void setPassword ( const string & password )

inline

Set password.

Parameters

password password

Definition at line 99 of file HTTPDownloadClient.h.

◆ setURL()

void setURL ( const string & url )

inline

Set URL.

Parameters

url URL

Definition at line 115 of file HTTPDownloadClient.h.

◆ setUsername()

void setUsername ( const string & username )

inline

Set username.

Parameters

username user name

Definition at line 83 of file HTTPDownloadClient.h.

◆ start()

void start ( )

Starts the HTTP download to file.

Definition at line 121 of file HTTPDownloadClient.cpp.

Member Data Documentation

◆ contentSize

uint64_t contentSize { 0LL }

private

Definition at line 42 of file HTTPDownloadClient.h.

◆ downloadThread

Thread* downloadThread { nullptr }

private

Definition at line 37 of file HTTPDownloadClient.h.

◆ downloadThreadMutex

Mutex downloadThreadMutex

private

Definition at line 38 of file HTTPDownloadClient.h.

◆ file

string file

private

Definition at line 30 of file HTTPDownloadClient.h.

◆ finished

volatile bool finished { true }

private

Definition at line 43 of file HTTPDownloadClient.h.

◆ haveContentSize

bool haveContentSize { false }

private

Definition at line 40 of file HTTPDownloadClient.h.

◆ haveHeaders

bool haveHeaders { false }

private

Definition at line 39 of file HTTPDownloadClient.h.

◆ headerSize

uint64_t headerSize { 0LL }

private

Definition at line 41 of file HTTPDownloadClient.h.

◆ HTTP_STATUSCODE_OK

const constexpr int16_t HTTP_STATUSCODE_OK { 200 }

staticconstexpr

Definition at line 64 of file HTTPDownloadClient.h.

◆ httpHeader

vector<string> httpHeader

private

Definition at line 35 of file HTTPDownloadClient.h.

◆ httpStatusCode

int16_t httpStatusCode { -1 }

private

Definition at line 34 of file HTTPDownloadClient.h.

◆ password

string password

private

Definition at line 32 of file HTTPDownloadClient.h.

◆ progress

volatile float progress { 0.0f }

private

Definition at line 44 of file HTTPDownloadClient.h.

◆ url

string url

private

Definition at line 29 of file HTTPDownloadClient.h.

◆ username

string username

private

Definition at line 31 of file HTTPDownloadClient.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/network/httpclient/HTTPDownloadClient.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/network/httpclient/HTTPDownloadClient.cpp

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HTTPDownloadClient()

Member Function Documentation

◆ cancel()

◆ createHTTPRequestHeaders()

◆ getFile()

◆ getPassword()

◆ getProgress()

◆ getResponseHeaders()

◆ getStatusCode()

◆ getURL()

◆ getUsername()

◆ isFinished()

◆ join()

◆ parseHTTPResponseHeaders()

◆ reset()

◆ setFile()

◆ setPassword()

◆ setURL()

◆ setUsername()

◆ start()

Member Data Documentation

◆ contentSize

◆ downloadThread

◆ downloadThreadMutex

◆ file

◆ finished

◆ haveContentSize

◆ haveHeaders

◆ headerSize

◆ HTTP_STATUSCODE_OK

◆ httpHeader

◆ httpStatusCode

◆ password

◆ progress

◆ url

◆ username