HttpClient Class Reference

Inheritance diagram for HttpClient:

Public Member Functions
virtual	~HttpClient ()
	HttpClient destructor. More...
bool	sendRequest (const Url &url, RequestCompletedDelegate requestComplete)
bool	sendRequest (const HttpMethod method, const Url &url, const HttpHeaders &headers, RequestCompletedDelegate requestComplete)
bool	sendRequest (const HttpMethod method, const Url &url, const HttpHeaders &headers, const String &body, RequestCompletedDelegate requestComplete)
bool	downloadString (const Url &url, RequestCompletedDelegate requestComplete)
bool	downloadFile (const Url &url, RequestCompletedDelegate requestComplete=nullptr)
bool	downloadFile (const Url &url, const String &saveFileName, RequestCompletedDelegate requestComplete=nullptr)
	Queue request to download a file. More...
bool	send (HttpRequest *request)
HttpRequest *	request (const String &url) SMING_DEPRECATED
HttpRequest *	createRequest (const Url &url)
	Helper function to create a new request on a URL. More...

Static Public Member Functions
static void	cleanup ()

Protected Types
typedef ObjectMap< String, HttpClientConnection >	HttpConnectionPool

Protected Member Functions
String	getCacheKey (const Url &url)

Static Protected Attributes
static HttpConnectionPool	httpConnectionPool

Constructor & Destructor Documentation

virtual HttpClient::~HttpClient ( )

inlinevirtual

HttpClient destructor.

Note

DON'T call cleanup. If you want to free all resources from HttpClients the correct sequence will be to

1. Delete all instances of HttpClient
2. Call the static method HttpClient::cleanup();

Member Function Documentation

static void HttpClient::cleanup ( )

inlinestatic

Use this method to clean all request queues and object pools

HttpRequest* HttpClient::createRequest ( const Url &  url )

inline

Helper function to create a new request on a URL.

Parameters

url

Return values

HttpRequest*

bool HttpClient::downloadFile	(	const Url &	url,
		const String &	saveFileName,
		RequestCompletedDelegate	requestComplete = nullptr
	)

Queue request to download a file.

Parameters

url	Source of file data
saveFilename	Path to save file to. Optional: specify nullptr to use name from url
requestComplete	Completion callback

HttpRequest* HttpClient::request ( const String &  url )

inline

Deprecated:

Use createRequest() instead