malloy::http::request< Body > Class Template Reference

#include <request.hpp>

Inheritance diagram for malloy::http::request< Body >:

Collaboration diagram for malloy::http::request< Body >:

Public Member Functions
	request (http::method method_, std::string_view host, const std::uint16_t port, std::string_view target_)
	request (msg_t &&raw)
	request (const request &other)=default
	request (request &&other) noexcept=default
virtual	~request ()=default
request &	operator= (const request &rhs)=default
request &	operator= (request &&rhs) noexcept=default
constexpr void	use_tls (const bool enabled) noexcept
constexpr bool	use_tls () const noexcept
constexpr std::uint16_t	port () const noexcept
std::unordered_map< std::string, std::string >	cookies () const noexcept
bool	has_cookie (const std::string &name) const
std::string_view	cookie (const std::string_view &name) const

Detailed Description

template<typename Body = boost::beast::http::string_body>
class malloy::http::request< Body >

Represents an HTTP request.

Constructor & Destructor Documentation

request() [1/4]

template<typename Body = boost::beast::http::string_body>

malloy::http::request< Body >::request ( http::method method_, std::string_view host, const std::uint16_t port, std::string_view target_ )

inline

Constructor.

Parameters

method_	The HTTP method
host	The host to connect to.
port	The port at which the host serves requests.
target_	The target.

request() [2/4]

template<typename Body = boost::beast::http::string_body>

malloy::http::request< Body >::request ( msg_t && raw )

inlineexplicit

Constructor

Parameters

raw	The underlying raw HTTP message

request() [3/4]

template<typename Body = boost::beast::http::string_body>

malloy::http::request< Body >::request ( const request< Body > & other )

default

Copy constructor.

Parameters

other

The object to copy construct from.

request() [4/4]

template<typename Body = boost::beast::http::string_body>

malloy::http::request< Body >::request ( request< Body > && other )

defaultnoexcept

Move constructor.

Parameters

other

The object to move-construct from.

~request()

template<typename Body = boost::beast::http::string_body>

virtual malloy::http::request< Body >::~request ( )

virtualdefault

Destructor.

Member Function Documentation

cookie()

template<typename Body = boost::beast::http::string_body>

std::string_view malloy::http::request< Body >::cookie ( const std::string_view & name ) const

inlinenodiscard

Gets the value of a cookie.

cookies()

template<typename Body = boost::beast::http::string_body>

std::unordered_map< std::string, std::string > malloy::http::request< Body >::cookies ( ) const

inlinenodiscardnoexcept

Returns the request's cookies.

Returns

The cookies.

has_cookie()

template<typename Body = boost::beast::http::string_body>

bool malloy::http::request< Body >::has_cookie ( const std::string & name ) const

inlinenodiscard

Checks whether a particular cookie is present.

Returns

Whether the specified cookie is present.

operator=() [1/2]

template<typename Body = boost::beast::http::string_body>

request & malloy::http::request< Body >::operator= ( const request< Body > & rhs )

default

Copy assignment operator.

Parameters

rhs	The object to copy-assign from.

Returns

A reference to the assignee.

operator=() [2/2]

template<typename Body = boost::beast::http::string_body>

request & malloy::http::request< Body >::operator= ( request< Body > && rhs )

defaultnoexcept

Move assignment operator.

Parameters

rhs	The object to move-assign from.

Returns

A reference to the assignee.

port()

template<typename Body = boost::beast::http::string_body>

std::uint16_t malloy::http::request< Body >::port ( ) const

inlinenodiscardconstexprnoexcept

Retrieve the port.

Returns

The port.

use_tls() [1/2]

template<typename Body = boost::beast::http::string_body>

bool malloy::http::request< Body >::use_tls ( ) const

inlinenodiscardconstexprnoexcept

Whether this request requires using TLS encryption.

Returns

Whether this request requires using TLS encryption.

use_tls() [2/2]

template<typename Body = boost::beast::http::string_body>

void malloy::http::request< Body >::use_tls ( const bool enabled )

inlineconstexprnoexcept

Set whether this request requires using TLS encryption.

Returns

Whether this request requires TLS encryption.

---

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

• lib/malloy/core/http/request.hpp