An HTTP fetch request includes body, headers, version, method, and URI. More...

#include <fetch.hpp>

Public Member Functions
	HttpFetch (http::Uri uri, http::HttpMethod method)
	Creates a request with the given method and URI, version as HTTP/1.1, no headers, and no body. More...

HttpFetch &	set_version (http::HttpVersion version)
	Sets the HTTP version of the request. More...

http::HttpVersion	get_version () const
	Gets the HTTP version of the request. More...

HttpFetch &	set_header (const std::string &header_name, const std::string &value)
	Sets a request header to the given value. More...

HttpFetch &	set_header (const std::string &header_name, const std::vector< std::string > &value)
	Sets a request header to the given values. More...

HttpFetch &	append_header (const std::string &header_name, const std::string &value)
	Appends a value to the existing request header. More...

HttpFetch &	set_headers (const edjx::http::HttpHeaders &value)
	Set request headers to the given values. More...

const edjx::http::HttpHeaders &	get_headers () const
	Returns a const reference to the request header map. More...

HttpFetch &	set_body (const std::string &text)
	Sets the given [`text`] value as the body of the request. More...

HttpFetch &	set_body (const std::vector< std::uint8_t > bytes)
	Sets the given [`bytes`] value as the body of the request. More...

const std::vector< uint8_t > &	get_body () const
	Returns a constant reference to the body. More...

edjx::error::HttpError	send (FetchResponse &response)
	Sends the request to the server, and returns after the response is received or an error occurs. More...

edjx::error::HttpError	send_streaming (FetchResponsePending &response, edjx::stream::WriteStream &write_stream)
	Starts streaming an HTTP Fetch request to the server. This method returns a `FetchResponsePending` object and an `edjx::stream::WriteStream` object. The `edjx::stream::WriteStream` object is used to stream data. The `FetchResponsePending` is a placeholder to retreive `FetchResponse`. In the background, this method triggers sending HTTP headers and other HTTP artifacts to the server. More...

Public Attributes
http::HttpVersion	version
	HTTP version of the request. More...

edjx::http::HttpHeaders	headers
	Headers for the request. More...

http::Uri	uri
	URI of the request. More...

http::HttpMethod	method
	Method for the request. More...

std::vector< uint8_t >	body
	Request body. More...

Detailed Description

An HTTP fetch request includes body, headers, version, method, and URI.

Constructor & Destructor Documentation

◆ HttpFetch()

edjx::fetch::HttpFetch::HttpFetch	(	http::Uri	uri,
		http::HttpMethod	method
	)

inline

Creates a request with the given method and URI, version as HTTP/1.1, no headers, and no body.

Parameters

uri	Request URI
method	Request method

Member Function Documentation

◆ append_header()

HttpFetch & edjx::fetch::HttpFetch::append_header	(	const std::string &	header_name,
		const std::string &	value
	)

Appends a value to the existing request header.

Keeps any previous values for the given header name.

Parameters

header_name	Header name
value	Header value

Returns: Reference to this HttpFetch object

◆ get_body()

const std::vector< uint8_t > & edjx::fetch::HttpFetch::get_body ( ) const

Returns a constant reference to the body.

Returns: Request body

◆ get_headers()

const edjx::http::HttpHeaders & edjx::fetch::HttpFetch::get_headers ( ) const

Returns a const reference to the request header map.

Returns: Request headers

◆ get_version()

http::HttpVersion edjx::fetch::HttpFetch::get_version ( ) const

Gets the HTTP version of the request.

Returns: HTTP version of the request

◆ send()

edjx::error::HttpError edjx::fetch::HttpFetch::send ( FetchResponse & response )

Sends the request to the server, and returns after the response is received or an error occurs.

Parameters

response

Returns: Returns edjx::error::HttpError::Success on success, some other value on failure.

◆ send_streaming()

edjx::error::HttpError edjx::fetch::HttpFetch::send_streaming	(	FetchResponsePending &	response,
		edjx::stream::WriteStream &	write_stream
	)

Starts streaming an HTTP Fetch request to the server. This method returns a FetchResponsePending object and an edjx::stream::WriteStream object. The edjx::stream::WriteStream object is used to stream data. The FetchResponsePending is a placeholder to retreive FetchResponse. In the background, this method triggers sending HTTP headers and other HTTP artifacts to the server.

This method and the send() method cannot be used together.

Parameters

response	A placeholder for the server's response will be copied to this object. It can retreive the server's response once the response is received.
write_stream	A write stream for streaming the HTTP Fetch request body.

Returns: Returns edjx::error::HttpError::Success on success, some other value on failure.

◆ set_body() [1/2]

HttpFetch & edjx::fetch::HttpFetch::set_body ( const std::string & text )

Sets the given [text] value as the body of the request.

Any body that was previously set on the request is discarded.

Parameters

text	String to be used as the body

Returns: Reference to this HttpFetch object

◆ set_body() [2/2]

HttpFetch & edjx::fetch::HttpFetch::set_body ( const std::vector< std::uint8_t > bytes )

Sets the given [bytes] value as the body of the request.

Any body that was previously set on the request is discarded.

Parameters

bytes Bytes to be used as the body

Returns: Reference to this HttpFetch object

◆ set_header() [1/2]

HttpFetch & edjx::fetch::HttpFetch::set_header	(	const std::string &	header_name,
		const std::string &	value
	)

Sets a request header to the given value.

Discards any previous values for the given header name.

Parameters

header_name	Header name
value	Header value

Returns: Reference to this HttpFetch object

◆ set_header() [2/2]

HttpFetch & edjx::fetch::HttpFetch::set_header	(	const std::string &	header_name,
		const std::vector< std::string > &	value
	)

Sets a request header to the given values.

Discards any previous values for the given header name.

Parameters

header_name	Header name
value	Header values

Returns: Reference to this HttpFetch object

◆ set_headers()

HttpFetch & edjx::fetch::HttpFetch::set_headers ( const edjx::http::HttpHeaders & value )

Set request headers to the given values.

All previously defined headers will be discarded.

Parameters

value HTTP headers

Returns: Reference to this HttpFetch object

◆ set_version()

HttpFetch & edjx::fetch::HttpFetch::set_version ( http::HttpVersion version )

Sets the HTTP version of the request.

Parameters

version Version to be set

Returns: Reference to this HttpFetch object

Member Data Documentation

◆ body

std::vector<uint8_t> edjx::fetch::HttpFetch::body

Request body.

◆ headers

edjx::http::HttpHeaders edjx::fetch::HttpFetch::headers

Headers for the request.

◆ method

http::HttpMethod edjx::fetch::HttpFetch::method

Method for the request.

◆ uri

http::Uri edjx::fetch::HttpFetch::uri

URI of the request.

◆ version

http::HttpVersion edjx::fetch::HttpFetch::version

HTTP version of the request.

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

include/edjx/fetch.hpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HttpFetch()

Member Function Documentation

◆ append_header()

◆ get_body()

◆ get_headers()

◆ get_version()

◆ send()

◆ send_streaming()

◆ set_body() [1/2]

◆ set_body() [2/2]

◆ set_header() [1/2]

◆ set_header() [2/2]

◆ set_headers()

◆ set_version()

Member Data Documentation

◆ body

◆ headers

◆ method

◆ uri

◆ version