NetFlex  0.0.0
C++11 HTTP Server Library.
Public Member Functions | List of all members
netflex::http::request Class Reference

#include <request.hpp>

Public Member Functions

 request (void)=default
 default ctor
 
 ~request (void)=default
 default dtor
 
 request (const request &)=default
 copy ctor
 
requestoperator= (const request &)=default
 assignment operator
 
method get_method (void) const
 
const std::string & get_raw_method (void) const
 
const std::string & get_target (void) const
 
const std::string & get_http_version (void) const
 
void set_method (method method)
 
void set_raw_method (const std::string &method)
 
void set_target (const std::string &target)
 
void set_http_version (const std::string &http_version)
 
const std::string & get_header (const std::string &name) const
 
const header_list_t & get_headers (void) const
 
void set_headers (const header_list_t &headers)
 
void add_header (const header &header)
 
bool has_header (const std::string &name) const
 
void remove_header (const std::string &name)
 
const std::string & get_path (void) const
 
const routing::params_t & get_params (void) const
 
void set_path (const std::string &path)
 
void set_params (const routing::params_t &params)
 
const std::string & get_body (void) const
 
void set_body (const std::string &body)
 
std::string to_string (void) const
 

Detailed Description

http request representation contains all information related to the received http request

Member Function Documentation

◆ add_header()

void netflex::http::request::add_header ( const header header)

add a new header to the request header if header already exists, override its value

Parameters
headerheader to be added

◆ get_body()

const std::string& netflex::http::request::get_body ( void  ) const
Returns
request body

◆ get_header()

const std::string& netflex::http::request::get_header ( const std::string &  name) const

return specific header throws an exception if header does not exist

Parameters
nameheader name to get
Returns
requested header value

◆ get_headers()

const header_list_t& netflex::http::request::get_headers ( void  ) const
Returns
all headers for request

◆ get_http_version()

const std::string& netflex::http::request::get_http_version ( void  ) const
Returns
request http version

◆ get_method()

method netflex::http::request::get_method ( void  ) const
Returns
request http verb

◆ get_params()

const routing::params_t& netflex::http::request::get_params ( void  ) const
Returns
request params (route params and GET params)

◆ get_path()

const std::string& netflex::http::request::get_path ( void  ) const
Returns
requested path

◆ get_raw_method()

const std::string& netflex::http::request::get_raw_method ( void  ) const
Returns
request http verb (string version)

◆ get_target()

const std::string& netflex::http::request::get_target ( void  ) const
Returns
status line target

◆ has_header()

bool netflex::http::request::has_header ( const std::string &  name) const

return whether the request contains a specific header

Parameters
nameheader name to check
Returns
whether the requested header is present or not

◆ remove_header()

void netflex::http::request::remove_header ( const std::string &  name)

remove a header from the request does nothing if header does not exist

Parameters
namename of the header to remove

◆ set_body()

void netflex::http::request::set_body ( const std::string &  body)

set request body

Parameters
bodynew request body

◆ set_headers()

void netflex::http::request::set_headers ( const header_list_t &  headers)

set request headers

Parameters
headersnew headers for request

◆ set_http_version()

void netflex::http::request::set_http_version ( const std::string &  http_version)

set new http version

Parameters
http_versionnew http version

◆ set_method()

void netflex::http::request::set_method ( method  method)

set new http verb

Parameters
methodnew http verb

◆ set_params()

void netflex::http::request::set_params ( const routing::params_t &  params)

set request params

Parameters
paramsnew request params

◆ set_path()

void netflex::http::request::set_path ( const std::string &  path)

set requested path

Parameters
pathnew path for request

◆ set_raw_method()

void netflex::http::request::set_raw_method ( const std::string &  method)

set new http verb (string version)

Parameters
methodnew http verb

◆ set_target()

void netflex::http::request::set_target ( const std::string &  target)

set new status line target

Parameters
targetnew status line target

◆ to_string()

std::string netflex::http::request::to_string ( void  ) const
Returns
printable version of the request (for logging purpose)

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