Builder for HTTP requests. More...

#include <RequestBuilder.hpp>

Public Member Functions
	RequestBuilder (std::string host, std::string port)
	Construct a new Request Builder object.

RequestBuilder &	addHeader (HttpHeader const &header)
	Add a header to the request.

RequestBuilder &	addHeaders (std::vector< HttpHeader > const &headers)
	Add headers to the request.

RequestBuilder &	addData (std::string data)
	Add body or data to the request.

RequestBuilder &	setTimeout (std::chrono::milliseconds timeout)
	Set the timeout for the request.

RequestBuilder &	setTarget (std::string_view target)
	Set the target for the request.

std::expected< std::string, RequestError >	getSsl (boost::asio::yield_context yield)
	Perform a GET request with SSL asynchronously.

std::expected< std::string, RequestError >	getPlain (boost::asio::yield_context yield)
	Perform a GET request without SSL asynchronously.

std::expected< std::string, RequestError >	get (boost::asio::yield_context yield)
	Perform a GET request asynchronously. The SSL will be used first, if it fails, the plain connection will be used.

std::expected< std::string, RequestError >	postSsl (boost::asio::yield_context yield)
	Perform a POST request with SSL asynchronously.

std::expected< std::string, RequestError >	postPlain (boost::asio::yield_context yield)
	Perform a POST request without SSL asynchronously.

std::expected< std::string, RequestError >	post (boost::asio::yield_context yield)
	Perform a POST request asynchronously. The SSL will be used first, if it fails, the plain connection will be used.

template<typename StreamDataType >
std::expected< std::string, RequestError >	doRequestImpl (StreamDataType &&streamData, asio::yield_context yield, http::verb const method)
	Perform a request asynchronously.

Static Public Attributes
static constexpr std::chrono::milliseconds	kDEFAULT_TIMEOUT {30000}

Detailed Description

Builder for HTTP requests.

Constructor & Destructor Documentation

◆ RequestBuilder()

util::requests::RequestBuilder::RequestBuilder	(	std::string	host,
		std::string	port )

Construct a new Request Builder object.

Parameters

host	host to connect to
port	port to connect to

Member Function Documentation

◆ addData()

RequestBuilder & util::requests::RequestBuilder::addData ( std::string data )

Add body or data to the request.

Parameters

data	data to add

Returns: Reference to itself

◆ addHeader()

RequestBuilder & util::requests::RequestBuilder::addHeader ( HttpHeader const & header )

Add a header to the request.

Parameters

header header to add

Returns: Reference to itself

◆ addHeaders()

RequestBuilder & util::requests::RequestBuilder::addHeaders ( std::vector< HttpHeader > const & headers )

Add headers to the request.

Parameters

headers headers to add

Returns: Reference to itself

◆ doRequestImpl()

template<typename StreamDataType >

std::expected< std::string, RequestError > util::requests::RequestBuilder::doRequestImpl	(	StreamDataType &&	streamData,
		asio::yield_context	yield,
		http::verb const	method )

Perform a request asynchronously.

Template Parameters

StreamDataType The type of the stream data

Parameters

streamData	The stream data
yield	The coroutine context
method	The HTTP method to use

Returns: Response or error

◆ get()

std::expected< std::string, RequestError > util::requests::RequestBuilder::get ( boost::asio::yield_context yield )

Perform a GET request asynchronously. The SSL will be used first, if it fails, the plain connection will be used.

Note: It is not thread-safe to call get() and post() of the same RequestBuilder from multiple threads. But it is fine to call only get() or only post() of the same RequestBuilder from multiple threads.

Parameters

yield yield context

Returns: Expected response or error

◆ getPlain()

std::expected< std::string, RequestError > util::requests::RequestBuilder::getPlain ( boost::asio::yield_context yield )

Perform a GET request without SSL asynchronously.

Note: It is not thread-safe to call get() and post() of the same RequestBuilder from multiple threads. But it is fine to call only get() or only post() of the same RequestBuilder from multiple threads.

Parameters

yield yield context

Returns: Expected response or error

◆ getSsl()

std::expected< std::string, RequestError > util::requests::RequestBuilder::getSsl ( boost::asio::yield_context yield )

Perform a GET request with SSL asynchronously.

Note: It is not thread-safe to call get() and post() of the same RequestBuilder from multiple threads. But it is fine to call only get() or only post() of the same RequestBuilder from multiple threads.

Parameters

yield yield context

Returns: Expected response or error

◆ post()

std::expected< std::string, RequestError > util::requests::RequestBuilder::post ( boost::asio::yield_context yield )

Perform a POST request asynchronously. The SSL will be used first, if it fails, the plain connection will be used.

Note: It is not thread-safe to call get() and post() of the same RequestBuilder from multiple threads. But it is fine to call only get() or only post() of the same RequestBuilder from multiple threads.

Parameters

yield yield context

Returns: Expected response or error

◆ postPlain()

std::expected< std::string, RequestError > util::requests::RequestBuilder::postPlain ( boost::asio::yield_context yield )

Perform a POST request without SSL asynchronously.

Note: It is not thread-safe to call get() and post() of the same RequestBuilder from multiple threads. But it is fine to call only get() or only post() of the same RequestBuilder from multiple threads.

Parameters

yield yield context

Returns: Expected response or error

◆ postSsl()

std::expected< std::string, RequestError > util::requests::RequestBuilder::postSsl ( boost::asio::yield_context yield )

Perform a POST request with SSL asynchronously.

Note: It is not thread-safe to call get() and post() of the same RequestBuilder from multiple threads. But it is fine to call only get() or only post() of the same RequestBuilder from multiple threads.

Parameters

yield yield context

Returns: Expected response or error

◆ setTarget()

RequestBuilder & util::requests::RequestBuilder::setTarget ( std::string_view target )

Set the target for the request.

Note: Default target is "/"

Parameters

target target to set

Returns: Reference to itself

◆ setTimeout()

RequestBuilder & util::requests::RequestBuilder::setTimeout ( std::chrono::milliseconds timeout )

Set the timeout for the request.

Note: Default timeout is defined in DEFAULT_TIMEOUT

Parameters

timeout timeout to set

Returns: Reference to itself

Member Data Documentation

◆ kDEFAULT_TIMEOUT

std::chrono::milliseconds util::requests::RequestBuilder::kDEFAULT_TIMEOUT {30000}

staticconstexpr

Default timeout for requests

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

/__w/clio/clio/src/util/requests/RequestBuilder.hpp
/__w/clio/clio/src/util/requests/RequestBuilder.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RequestBuilder()

Member Function Documentation

◆ addData()

◆ addHeader()

◆ addHeaders()

◆ doRequestImpl()

◆ get()

◆ getPlain()

◆ getSsl()

◆ post()

◆ postPlain()

◆ postSsl()

◆ setTarget()

◆ setTimeout()

Member Data Documentation

◆ kDEFAULT_TIMEOUT