Basic HTTP client. More...

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

Collaboration diagram for HTTPClient:

Public Member Functions
const string &	getURL ()
	Get URL. More...

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

const string &	getMethod ()
	Get method. More...

void	setMethod (const string &method)
	Set method. 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 unordered_map< string, string > &	getGETParameters ()
	Get GET parameter. More...

void	setGETParameters (const unordered_map< string, string > &parameters)
	Set GET parameter. More...

const unordered_map< string, string > &	getPOSTParameters ()
	Get POST parameter. More...

void	setPOSTParameters (const unordered_map< string, string > &parameters)
	Set POST parameter. More...

const string &	getBody ()
	Get body. More...

void	setBody (const string &contentType, const string &body)
	Set body. More...

const string &	getContentType ()
	Get content type. More...

void	setContentType (const string &contentType)
	Set content type. More...

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

void	execute ()
	Execute HTTP request. More...

stringstream &	getResponse ()

int16_t	getStatusCode ()

const vector< string > &	getResponseHeaders ()

Static Public Member Functions
static string	urlEncode (const string &value)
	Returns a URL encoded representation of value. More...

Static Public Attributes
static const constexpr int16_t	HTTP_STATUSCODE_OK { 200 }

static const string	HTTP_METHOD_GET = "GET"

static const string	HTTP_METHOD_HEAD = "HEAD"

static const string	HTTP_METHOD_POST = "POST"

static const string	HTTP_METHOD_PUT = "PUT"

static const string	HTTP_METHOD_DELETE = "DELETE"

Private Member Functions
string	createHTTPRequestHeaders (const string &hostName, const string &method, const string &relativeUrl, const unordered_map< string, string > &getParameters, const unordered_map< string, string > &postParameters, const string &body)
	Create HTTP request headers. More...

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

Private Attributes
string	url

string	method

unordered_map< string, string >	getParameters

unordered_map< string, string >	postParameters

string	body

string	contentType

string	username

string	password

stringstream	rawResponse

int16_t	httpStatusCode

vector< string >	httpHeader

Detailed Description

Basic HTTP client.

Author: Andreas Drewke

Definition at line 24 of file HTTPClient.h.

Member Function Documentation

◆ createHTTPRequestHeaders()

string createHTTPRequestHeaders	(	const string &	hostName,
		const string &	method,
		const string &	relativeUrl,
		const unordered_map< string, string > &	getParameters,
		const unordered_map< string, string > &	postParameters,
		const string &	body
	)

private

Create HTTP request headers.

Parameters

hostName	host name
method	method
relativeUrl	url relative to server root
getParameters	get parameters
postParameter	post parameters
body	body

Definition at line 78 of file HTTPClient.cpp.

◆ execute()

void execute ( )

Execute HTTP request.

Exceptions

tdme::network::httpclient::HTTPClientException
tdme::os::network::NetworkException

Definition at line 159 of file HTTPClient.cpp.

◆ getBody()

const string & getBody ( )

inline

Get body.

Returns: body

Definition at line 169 of file HTTPClient.h.

◆ getContentType()

const string & getContentType ( )

inline

Get content type.

Returns: content type

Definition at line 187 of file HTTPClient.h.

◆ getGETParameters()

const unordered_map< string, string > & getGETParameters ( )

inline

Get GET parameter.

Returns: GET parameter

Definition at line 137 of file HTTPClient.h.

◆ getMethod()

const string & getMethod ( )

inline

Get method.

Returns: method

Definition at line 89 of file HTTPClient.h.

◆ getPassword()

const string & getPassword ( )

inline

Get password.

Returns: password

Definition at line 121 of file HTTPClient.h.

◆ getPOSTParameters()

const unordered_map< string, string > & getPOSTParameters ( )

inline

Get POST parameter.

Returns: POST parameter

Definition at line 153 of file HTTPClient.h.

◆ getResponse()

stringstream & getResponse ( )

inline

Returns: complete response stream

Definition at line 215 of file HTTPClient.h.

◆ getResponseHeaders()

const vector< string > & getResponseHeaders ( )

inline

Returns: HTTP response headers

Definition at line 229 of file HTTPClient.h.

◆ getStatusCode()

int16_t getStatusCode ( )

inline

Returns: HTTP status code

Definition at line 222 of file HTTPClient.h.

◆ getURL()

const string & getURL ( )

inline

Get URL.

Returns: URL

Definition at line 73 of file HTTPClient.h.

◆ getUsername()

const string & getUsername ( )

inline

Get username.

Returns: username

Definition at line 105 of file HTTPClient.h.

◆ parseHTTPResponseHeaders()

void parseHTTPResponseHeaders	(	stringstream &	rawResponse,
		int16_t &	httpStatusCode,
		vector< string > &	httpHeader
	)

private

Parse HTTP response headers.

Parameters

rawResponse	raw response
httpStatusCode	HTTP status code
httpHeader	HTTP header

Definition at line 116 of file HTTPClient.cpp.

◆ reset()

void reset ( )

Reset this HTTP client.

Definition at line 146 of file HTTPClient.cpp.

◆ setBody()

void setBody	(	const string &	contentType,
		const string &	body
	)

inline

Set body.

Parameters

contentType	content type
body	body

Definition at line 178 of file HTTPClient.h.

◆ setContentType()

void setContentType ( const string & contentType )

inline

Set content type.

Parameters

contentType content type

Definition at line 195 of file HTTPClient.h.

◆ setGETParameters()

void setGETParameters ( const unordered_map< string, string > & parameters )

inline

Set GET parameter.

Parameters

GET parameter

Definition at line 145 of file HTTPClient.h.

◆ setMethod()

void setMethod ( const string & method )

inline

Set method.

Parameters

method method

Definition at line 97 of file HTTPClient.h.

◆ setPassword()

void setPassword ( const string & password )

inline

Set password.

Parameters

password password

Definition at line 129 of file HTTPClient.h.

◆ setPOSTParameters()

void setPOSTParameters ( const unordered_map< string, string > & parameters )

inline

Set POST parameter.

Parameters

POST parameter

Definition at line 161 of file HTTPClient.h.

◆ setURL()

void setURL ( const string & url )

inline

Set URL.

Parameters

url URL

Definition at line 81 of file HTTPClient.h.

◆ setUsername()

void setUsername ( const string & username )

inline

Set username.

Parameters

username user name

Definition at line 113 of file HTTPClient.h.

◆ urlEncode()

string urlEncode ( const string & value )

static

Returns a URL encoded representation of value.

Returns: URL encoded value

Definition at line 53 of file HTTPClient.cpp.

Member Data Documentation

◆ body

string body

private

Definition at line 31 of file HTTPClient.h.

◆ contentType

string contentType

private

Definition at line 32 of file HTTPClient.h.

◆ getParameters

unordered_map<string, string> getParameters

private

Definition at line 29 of file HTTPClient.h.

◆ HTTP_METHOD_DELETE

const string HTTP_METHOD_DELETE = "DELETE"

static

Definition at line 67 of file HTTPClient.h.

◆ HTTP_METHOD_GET

const string HTTP_METHOD_GET = "GET"

static

Definition at line 63 of file HTTPClient.h.

◆ HTTP_METHOD_HEAD

const string HTTP_METHOD_HEAD = "HEAD"

static

Definition at line 64 of file HTTPClient.h.

◆ HTTP_METHOD_POST

const string HTTP_METHOD_POST = "POST"

static

Definition at line 65 of file HTTPClient.h.

◆ HTTP_METHOD_PUT

const string HTTP_METHOD_PUT = "PUT"

static

Definition at line 66 of file HTTPClient.h.

◆ HTTP_STATUSCODE_OK

const constexpr int16_t HTTP_STATUSCODE_OK { 200 }

staticconstexpr

Definition at line 61 of file HTTPClient.h.

◆ httpHeader

vector<string> httpHeader

private

Definition at line 38 of file HTTPClient.h.

◆ httpStatusCode

int16_t httpStatusCode

private

Definition at line 37 of file HTTPClient.h.

◆ method

string method

private

Definition at line 28 of file HTTPClient.h.

◆ password

string password

private

Definition at line 34 of file HTTPClient.h.

◆ postParameters

unordered_map<string, string> postParameters

private

Definition at line 30 of file HTTPClient.h.

◆ rawResponse

stringstream rawResponse

private

Definition at line 36 of file HTTPClient.h.

◆ url

string url

private

Definition at line 27 of file HTTPClient.h.

◆ username

string username

private

Definition at line 33 of file HTTPClient.h.

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ createHTTPRequestHeaders()

◆ execute()

◆ getBody()

◆ getContentType()

◆ getGETParameters()

◆ getMethod()

◆ getPassword()

◆ getPOSTParameters()

◆ getResponse()

◆ getResponseHeaders()

◆ getStatusCode()

◆ getURL()

◆ getUsername()

◆ parseHTTPResponseHeaders()

◆ reset()

◆ setBody()

◆ setContentType()

◆ setGETParameters()

◆ setMethod()

◆ setPassword()

◆ setPOSTParameters()

◆ setURL()

◆ setUsername()

◆ urlEncode()

Member Data Documentation

◆ body

◆ contentType

◆ getParameters

◆ HTTP_METHOD_DELETE

◆ HTTP_METHOD_GET

◆ HTTP_METHOD_HEAD

◆ HTTP_METHOD_POST

◆ HTTP_METHOD_PUT

◆ HTTP_STATUSCODE_OK

◆ httpHeader

◆ httpStatusCode

◆ method

◆ password

◆ postParameters

◆ rawResponse

◆ url

◆ username