anch::rest::Request Class Reference

HTTP request. More...

#include <request.hpp>

Collaboration diagram for anch::rest::Request:

Classes
class	Builder
	HTTP request builder. More...

Public Member Functions
	Request ()
	Request (const Request &res)=delete
	Request (Request &&other)
virtual	~Request ()
Request &	operator= (Request &&other)
template<typename T>
T	getBody ()
const std::string &	getVerb () const
void	setVerb (const std::string &verb)
const anch::rest::Headers &	getHeaders () const
void	setHeaders (const anch::rest::Headers &headers)
std::string	getContentType () const
void	setContentType (const std::string &contentType)
const std::optional< const std::vector< std::string > >	getAccept () const
void	setAccept (const std::vector< std::string > &accept)
const std::string &	getPath () const
void	setPath (const std::string &path)
const std::vector< std::string > &	getParameters () const
void	setParameters (const std::vector< std::string > &parameters)

Static Public Member Functions
static Builder	builder ()

Detailed Description

HTTP request.

HTTP request representation

Author

Vincent Lachenal

Since

0.1

Constructor & Destructor Documentation

Request() [1/3]

anch::rest::Request::Request

(

)

Request default constructor

Request() [2/3]

anch::rest::Request::Request ( const Request & res )

delete

Request copy constructor

Parameters

res	the Request to move

Here is the call graph for this function:

Request() [3/3]

anch::rest::Request::Request

(

Request &&

other

)

Request move construtor

Here is the call graph for this function:

~Request()

virtual anch::rest::Request::~Request ( )

virtual

Request destructor

Member Function Documentation

builder()

Builder anch::rest::Request::builder ( )

static

Instanciate a new request builder for fluent API usage

Returns

the new builder

getAccept()

const std::optional< const std::vector< std::string > > anch::rest::Request::getAccept

(

)

const

Accepted media types getter

Returns

the media types

getBody()

template<typename T>

T anch::rest::Request::getBody

(

)

Get body from input stream

Returns

the body

getContentType()

std::string anch::rest::Request::getContentType

(

)

const

Media type getter

Returns

the media type

getHeaders()

const anch::rest::Headers & anch::rest::Request::getHeaders

(

)

const

HTTP headers getter

Returns

the headers

getParameters()

const std::vector< std::string > & anch::rest::Request::getParameters

(

)

const

Path parameters getter

Returns

the parameters

getPath()

const std::string & anch::rest::Request::getPath

(

)

const

Request path getter

Returns

the path

getVerb()

const std::string & anch::rest::Request::getVerb

(

)

const

HTTP verb getter

Returns

the verb

operator=()

Request & anch::rest::Request::operator=

(

Request &&

other

)

Move assignement

Parameters

other

the Request to move

Returns

the new request

Here is the call graph for this function:

setAccept()

void anch::rest::Request::setAccept

(

const std::vector< std::string > &

accept

)

Accepted media types setter

Parameters

accept

the media types to set

setContentType()

void anch::rest::Request::setContentType

(

const std::string &

contentType

)

Media type setter

Parameters

content

the content type to set

setHeaders()

void anch::rest::Request::setHeaders

(

const anch::rest::Headers &

headers

)

HTTP headers setter.
This method will override every headers previously set.

Returns

the headers

setParameters()

void anch::rest::Request::setParameters

(

const std::vector< std::string > &

parameters

)

Path parameters setter

Parameters

parameters

the parameters to set

setPath()

void anch::rest::Request::setPath

(

const std::string &

path

)

Request path setter

Parameters

path	the path to set

setVerb()

void anch::rest::Request::setVerb

(

const std::string &

verb

)

HTTP verb getter

Parameters

verb	the HTTP verb to set

---

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

• anch-rest/common/inc/rest/request.hpp