Encapsulates an incoming or outgoing request. More...

#include <HttpRequest.h>

Collaboration diagram for HttpRequest:

Public Types
using	SslInitDelegate = Delegate< void(Ssl::Session &session, HttpRequest &request)>
	Callback delegate type used to initialise an SSL session for a given request. More...

Public Member Functions
	HttpRequest ()

	HttpRequest (const Url &uri)

	HttpRequest (const HttpRequest &value)
	Copy constructor. More...

HttpRequest *	clone () const
	Clone this request into a new object using the copy constructor. More...

	~HttpRequest ()

HttpRequest *	setURL (const Url &uri)

HttpRequest *	setMethod (HttpMethod method)

HttpRequest *	setHeaders (const HttpHeaders &headers)

HttpRequest *	setHeader (const String &name, const String &value)

HttpRequest *	setPostParameter (const String &name, const String &value)

HttpRequest *	setFile (const String &formElementName, ReadWriteStream *stream)
	Sets a file to be sent. More...

HttpRequest *	setAuth (AuthAdapter *adapter)

const String &	getHeader (const String &name)
	Get header field value. More...

const String &	getPostParameter (const String &name)
	Get POST parameter value. More...

String	getQueryParameter (const String &name, const String &defaultValue=nullptr) const
	Get parameter from query fields. More...

String	getBody ()
	Moves content from the body stream into a String. More...

IDataSourceStream *	getBodyStream ()
	Return the current body stream. More...

HttpRequest *	setResponseStream (ReadWriteStream *stream)
	Instead of storing the response body we can set a stream that will take care to process it. More...

ReadWriteStream *	getResponseStream ()
	Get the response stream (if any) More...

HttpRequest *	onHeadersComplete (RequestHeadersCompletedDelegate delegateFunction)

HttpRequest *	onBody (RequestBodyDelegate delegateFunction)

HttpRequest *	onRequestComplete (RequestCompletedDelegate delegateFunction)

void	reset ()
	Clear buffers and reset to default state in preparation for another request. More...

HttpRequest *	onSslInit (SslInitDelegate delegate)
	To customise SSL session options, provide a callback. More...

String	toString () const
	Tries to present a readable version of the current request values. More...

Set request body content
HttpRequest *	setBody (const String &body)
	Set body from String object. More...

HttpRequest *	setBody (String &&body) noexcept
	Set body from String object using move semantics: body will be invalid on return. More...

HttpRequest *	setBody (IDataSourceStream *stream)
	Set body using given stream object, and retain ownership. More...

HttpRequest *	setBody (const uint8_t *rawData, size_t length)
	Set body content by copying binary data. More...

Static Public Member Functions
static String	toString (const HttpRequest &req)
	Tries to present a readable version of the request. More...

Public Attributes
Url	uri
	Request URL. More...

HttpMethod	method = HTTP_GET
	Request method. More...

HttpHeaders	headers
	Request headers. More...

HttpParams	postParams
	POST parameters. More...

HttpFiles	files
	Attached files. More...

int	retries = 0
	how many times the request should be send again... More...

void *	args = nullptr
	Used to store data that should be valid during a single request. More...

Protected Attributes
RequestHeadersCompletedDelegate	headersCompletedDelegate

RequestBodyDelegate	requestBodyDelegate

RequestCompletedDelegate	requestCompletedDelegate

SslInitDelegate	sslInitDelegate

IDataSourceStream *	bodyStream = nullptr

ReadWriteStream *	responseStream = nullptr
	User-requested stream to store response. More...

AuthAdapter *	auth = nullptr

Friends
class	HttpClientConnection

class	HttpServerConnection

Detailed Description

Encapsulates an incoming or outgoing request.

Member Typedef Documentation

◆ SslInitDelegate

using HttpRequest::SslInitDelegate = Delegate<void(Ssl::Session& session, HttpRequest& request)>

Callback delegate type used to initialise an SSL session for a given request.

Constructor & Destructor Documentation

◆ HttpRequest() [1/3]

HttpRequest::HttpRequest ( )

inline

◆ HttpRequest() [2/3]

HttpRequest::HttpRequest ( const Url & uri )

inline

◆ HttpRequest() [3/3]

HttpRequest::HttpRequest ( const HttpRequest & value )

inline

Copy constructor.

Note: Internal streams are not copied so these must be dealt with afterwards

◆ ~HttpRequest()

HttpRequest::~HttpRequest ( )

inline

Member Function Documentation

◆ clone()

HttpRequest* HttpRequest::clone ( ) const

inline

Clone this request into a new object using the copy constructor.

Return values

HttpRequest* The new request object

See also: HttpRequest(const HttpRequest& value)

◆ getBody()

String HttpRequest::getBody ( )

inline

Moves content from the body stream into a String.

Return values

String

Note: Move semantics are used to ensure that no/minimal additional memory is required. If your application has set a non-memory stream type then the method will fail and return an invalid String. The stream content will be left unchanged.

◆ getBodyStream()

IDataSourceStream* HttpRequest::getBodyStream ( )

inline

Return the current body stream.

Return values

IDataSourceStream*

Note: may return null

◆ getHeader()

const String& HttpRequest::getHeader ( const String & name )

inline

Get header field value.

Parameters

name	Name of field

Return values

const String& Value, will be invalid (i.e. if() == false) if field not present

◆ getPostParameter()

const String& HttpRequest::getPostParameter ( const String & name )

inline

Get POST parameter value.

Parameters

name	Name of parameter

Return values

const String& Value, will be invalid (i.e. if() == false) if field not present

◆ getQueryParameter()

String HttpRequest::getQueryParameter	(	const String &	name,
		const String &	defaultValue = `nullptr`
	)		const

inline

Get parameter from query fields.

Parameters

name	Name of parameter
defaultValue	Optional default value to use if requested parameter not present

◆ getResponseStream()

ReadWriteStream* HttpRequest::getResponseStream ( )

inline

Get the response stream (if any)

◆ onBody()

HttpRequest* HttpRequest::onBody ( RequestBodyDelegate delegateFunction )

inline

◆ onHeadersComplete()

HttpRequest* HttpRequest::onHeadersComplete ( RequestHeadersCompletedDelegate delegateFunction )

inline

◆ onRequestComplete()

HttpRequest* HttpRequest::onRequestComplete ( RequestCompletedDelegate delegateFunction )

inline

◆ onSslInit()

HttpRequest* HttpRequest::onSslInit ( SslInitDelegate delegate )

inline

To customise SSL session options, provide a callback.

Parameters

delegate Invoked before creating SSL connection

◆ reset()

void HttpRequest::reset ( )

Clear buffers and reset to default state in preparation for another request.

◆ setAuth()

HttpRequest* HttpRequest::setAuth ( AuthAdapter * adapter )

inline

◆ setBody() [1/4]

HttpRequest* HttpRequest::setBody ( const String & body )

inline

Set body from String object.

◆ setBody() [2/4]

HttpRequest* HttpRequest::setBody	(	const uint8_t *	rawData,
		size_t	length
	)

Set body content by copying binary data.

Parameters

rawData	Data to copy
length	Number of bytes to copy

◆ setBody() [3/4]

HttpRequest* HttpRequest::setBody ( IDataSourceStream * stream )

Set body using given stream object, and retain ownership.

◆ setBody() [4/4]

HttpRequest* HttpRequest::setBody ( String && body )

noexcept

Set body from String object using move semantics: body will be invalid on return.

◆ setFile()

HttpRequest* HttpRequest::setFile	(	const String &	formElementName,
		ReadWriteStream *	stream
	)

inline

Sets a file to be sent.

Parameters

formElementName	The name of the element in the form
stream	Pointer to the stream (doesn't have to be a FileStream)

Return values

HttpRequest*

◆ setHeader()

HttpRequest* HttpRequest::setHeader	(	const String &	name,
		const String &	value
	)

inline

◆ setHeaders()

HttpRequest* HttpRequest::setHeaders ( const HttpHeaders & headers )

inline

◆ setMethod()

HttpRequest* HttpRequest::setMethod ( HttpMethod method )

inline

◆ setPostParameter()

HttpRequest* HttpRequest::setPostParameter	(	const String &	name,
		const String &	value
	)

inline

◆ setResponseStream()

HttpRequest* HttpRequest::setResponseStream ( ReadWriteStream * stream )

Instead of storing the response body we can set a stream that will take care to process it.

Parameters

stream

Return values

HttpRequest*

Note: The response to this request will be stored in the user-provided stream.

◆ setURL()

HttpRequest* HttpRequest::setURL ( const Url & uri )

inline

◆ toString() [1/2]

String HttpRequest::toString ( ) const

Tries to present a readable version of the current request values.

Return values

String

◆ toString() [2/2]

static String HttpRequest::toString ( const HttpRequest & req )

inlinestatic

Tries to present a readable version of the request.

Parameters

req

Return values

String

Friends And Related Function Documentation

◆ HttpClientConnection

friend class HttpClientConnection

friend

◆ HttpServerConnection

friend class HttpServerConnection

friend

Member Data Documentation

◆ args

void* HttpRequest::args = nullptr

Used to store data that should be valid during a single request.

◆ auth

AuthAdapter* HttpRequest::auth = nullptr

protected

◆ bodyStream

IDataSourceStream* HttpRequest::bodyStream = nullptr

protected

◆ files

HttpFiles HttpRequest::files

Attached files.

◆ headers

HttpHeaders HttpRequest::headers

Request headers.

◆ headersCompletedDelegate

RequestHeadersCompletedDelegate HttpRequest::headersCompletedDelegate

protected

◆ method

HttpMethod HttpRequest::method = HTTP_GET

Request method.

◆ postParams

HttpParams HttpRequest::postParams

POST parameters.

◆ requestBodyDelegate

RequestBodyDelegate HttpRequest::requestBodyDelegate

protected

◆ requestCompletedDelegate

RequestCompletedDelegate HttpRequest::requestCompletedDelegate

protected

◆ responseStream

ReadWriteStream* HttpRequest::responseStream = nullptr

protected

User-requested stream to store response.

◆ retries

int HttpRequest::retries = 0

how many times the request should be send again...

◆ sslInitDelegate

SslInitDelegate HttpRequest::sslInitDelegate

protected

◆ uri

Url HttpRequest::uri

Request URL.

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

HttpRequest.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ SslInitDelegate

Constructor & Destructor Documentation

◆ HttpRequest() [1/3]

◆ HttpRequest() [2/3]

◆ HttpRequest() [3/3]

◆ ~HttpRequest()

Member Function Documentation

◆ clone()

◆ getBody()

◆ getBodyStream()

◆ getHeader()

◆ getPostParameter()

◆ getQueryParameter()

◆ getResponseStream()

◆ onBody()

◆ onHeadersComplete()

◆ onRequestComplete()

◆ onSslInit()

◆ reset()

◆ setAuth()

◆ setBody() [1/4]

◆ setBody() [2/4]

◆ setBody() [3/4]

◆ setBody() [4/4]

◆ setFile()

◆ setHeader()

◆ setHeaders()

◆ setMethod()

◆ setPostParameter()

◆ setResponseStream()

◆ setURL()

◆ toString() [1/2]

◆ toString() [2/2]

Friends And Related Function Documentation

◆ HttpClientConnection

◆ HttpServerConnection

Member Data Documentation

◆ args

◆ auth

◆ bodyStream

◆ files

◆ headers

◆ headersCompletedDelegate

◆ method

◆ postParams

◆ requestBodyDelegate

◆ requestCompletedDelegate

◆ responseStream

◆ retries

◆ sslInitDelegate

◆ uri