Constructs a new HTTP request with the 'GET' method.

Constructs a new HTTP request with the given request method.

Parameters

mtd Request method.

Destructor frees any held resources.

These are used for the initial creation of the HTTP request.

Gets the server context associated with this HTTP message.

Sends a response if one has not already been sent.

Get an absolute URI with scheme, host, port, path, query, and fragment part of the request message.

Absolute URI is only valid after this http_request object has been passed to http_client::request().

Produces a stream which the caller may use to retrieve data from an incoming request.

Returns

A readable, open asynchronous stream.

This cannot be used in conjunction with any other means of getting the body of the request. It is not necessary to wait until the message has been sent before starting to write to the stream, but it is advisable to do so, since it will allow the network I/O to start earlier and the work of sending data can be overlapped with the production of more data.

Signals the user (listener) when all the data for this request message has been received.

Returns

A task which is completed when all of the response body has been received

Extracts the body of the request message into a json value, checking that the content type is application/json. A body can only be extracted once because in some cases an optimization is made where the data is 'moved' out.

Parameters

ignore_content_type If true, ignores the Content-Type header and assumes UTF-8.

Returns

JSON value from the body of this message.

Extract the body of the request message as a string value, checking that the content type is a MIME text type. A body can only be extracted once because in some cases an optimization is made where the data is 'moved' out.

Parameters

ignore_content_type If true, ignores the Content-Type header and assumes UTF-8.

Returns

String containing body of the message.

Extract the body of the request message as a UTF-16 string value, checking that the content type is a MIME text type. A body can only be extracted once because in some cases an optimization is made where the data is 'moved' out.

Parameters

ignore_content_type If true, ignores the Content-Type header and assumes UTF-16.

Returns

String containing body of the message.

Extract the body of the request message as a UTF-8 string value, checking that the content type is a MIME text type. A body can only be extracted once because in some cases an optimization is made where the data is 'moved' out.

Parameters

ignore_content_type If true, ignores the Content-Type header and assumes UTF-8.

Returns

String containing body of the message.

Extract the body of the response message into a vector of bytes. Extracting a vector can be done on

Returns

The body of the message as a vector of bytes.

Gets a task representing the response that will eventually be sent.

Returns

A task that is completed once response is sent.

Gets a reference to the headers of the response message.

Returns

HTTP headers for this response.

Use the http_headers::add to fill in desired headers.

Gets a const reference to the headers of the response message.

Returns

HTTP headers for this response.

Use the http_headers::add to fill in desired headers.

Get the method (GET/PUT/POST/DELETE) of the request message.

Returns

Request method of this HTTP request.

Gets a reference the URI path, query, and fragment part of this request message. This will be appended to the base URI specified at construction of the http_client.

Returns

A string.

When the request is the one passed to a listener's handler, the relative URI is the request URI less the listener's path. In all other circumstances, request_uri() and relative_uri() will return the same value.

Asynchronously responses to this HTTP request.

Parameters

response Response to send.

Returns

An asynchronous operation that is completed once response is sent.

Asynchronously responses to this HTTP request.

Parameters

status Response status code.

Returns

An asynchronous operation that is completed once response is sent.

Responds to this HTTP request.

Parameters

status Response status code.

body_data Json value to use in the response body.

Returns

An asynchronous operation that is completed once response is sent.

Responds to this HTTP request with a string. Assumes the character encoding of the string is UTF-8.

Parameters

status Response status code.

body_data UTF-8 string containing the text to use in the response body.

content_type Content type of the body.

Returns

An asynchronous operation that is completed once response is sent.

sent to before the body data is destroyed or goes out of scope.

Responds to this HTTP request with a string. Assumes the character encoding of the string is UTF-8.

Parameters

status Response status code.

body_data UTF-8 string containing the text to use in the response body.

content_type Content type of the body.

Returns

An asynchronous operation that is completed once response is sent.

sent to before the body data is destroyed or goes out of scope.

Responds to this HTTP request with a string. Assumes the character encoding of the string is UTF-16 will perform conversion to UTF-8.

Parameters

status Response status code.

body_data UTF-16 string containing the text to use in the response body.

content_type Content type of the body.

Returns

An asynchronous operation that is completed once response is sent.

sent to before the body data is destroyed or goes out of scope.

Responds to this HTTP request.

Parameters

status Response status code.

content_type A string holding the MIME type of the message body.

body An asynchronous stream representing the body data.

Returns

A task that is completed once a response from the request is received.

Responds to this HTTP request.

Parameters

status Response status code.

content_length The size of the data to be sent in the body..

content_type A string holding the MIME type of the message body.

body An asynchronous stream representing the body data.

Returns

A task that is completed once a response from the request is received.

Get the underling URI of the request message.

Returns

The uri of this message.

Sets the body of the message to a textual string and set the "Content-Type" header. Assumes the character encoding of the string is UTF-8.

Parameters

body_text String containing body text.

content_type MIME type to set the "Content-Type" header to. Default to "text/plain; charset=utf-8".

This will overwrite any previously set body data and "Content-Type" header.

Sets the body of the message to a textual string and set the "Content-Type" header. Assumes the character encoding of the string is UTF-8.

Parameters

body_text String containing body text.

content_type MIME type to set the "Content-Type" header to. Default to "text/plain; charset=utf-8".

This will overwrite any previously set body data and "Content-Type" header.

Sets the body of the message to a textual string and set the "Content-Type" header. Assumes the character encoding of the string is UTF-16 will perform conversion to UTF-8.

Parameters

body_text String containing body text.

content_type MIME type to set the "Content-Type" header to. Default to "text/plain".

This will overwrite any previously set body data and "Content-Type" header.

Sets the body of the message to contain json value. If the 'Content-Type' header hasn't already been set it will be set to 'application/json'.

Parameters

body_data json value.

This will overwrite any previously set body data.

Sets the body of the message to the contents of a byte vector. If the 'Content-Type' header hasn't already been set it will be set to 'application/octet-stream'.

Parameters

body_data Vector containing body data.

This will overwrite any previously set body data.

Sets the body of the message to the contents of a byte vector. If the 'Content-Type' header hasn't already been set it will be set to 'application/octet-stream'.

Parameters

body_data Vector containing body data.

This will overwrite any previously set body data.

Defines a stream that will be relied on to provide the body of the HTTP message when it is sent.

Parameters

stream A readable, open asynchronous stream.

content_type A string holding the MIME type of the message body.

This cannot be used in conjunction with any other means of setting the body of the request. The stream will not be read until the message is sent.

Defines a stream that will be relied on to provide the body of the HTTP message when it is sent.

Parameters

stream A readable, open asynchronous stream.

content_length The size of the data to be sent in the body.

content_type A string holding the MIME type of the message body.

This cannot be used in conjunction with any other means of setting the body of the request. The stream will not be read until the message is sent.

Get the method (GET/PUT/POST/DELETE) of the request message.

Parameters

method Request method of this HTTP request.

Defines a callback function that will be invoked for every chunk of data uploaded or downloaded as part of the request.

Parameters

handler A function representing the progress handler. It's parameters are: up: a message_direction::direction value indicating the direction of the message that is being reported. progress: the number of bytes that have been processed so far.

This function will be called at least once for upload and at least once for the download body, unless there is some exception generated. An HTTP message with an error code is not an exception. This means, that even if there is no body, the progress handler will be called.

Setting the chunk size on the http_client does not guarantee that the client will be using exactly that increment for uploading and downloading data.

The handler will be called only once for each combination of argument values, in order. Depending on how a service responds, some download values may come before all upload values have been reported.

The progress handler will be called on the thread processing the request. This means that the implementation of the handler must take care not to block the thread or do anything that takes significant amounts of time. In particular, do not do any kind of I/O from within the handler, do not update user interfaces, and to not acquire any locks. If such activities are necessary, it is the handler's responsibility to execute that work on a separate thread.

Set the underling URI of the request message.

Parameters

uri The uri for this message.

Defines a stream that will be relied on to hold the body of the HTTP response message that results from the request.

Parameters

stream A writable, open asynchronous stream.

If this function is called, the body of the response should not be accessed in any other way.

Generates a string representation of the message, including the body when possible. Mainly this should be used for debugging purposes as it has to copy the message body and doesn't have excellent performance.

Returns

A string representation of this HTTP request.

Note this function is synchronous and doesn't wait for the entire message body to arrive. If the message body has arrived by the time this function is called and it is has a textual Content-Type it will be included. Otherwise just the headers will be present.