cgv
Loading...
Searching...
No Matches
cgv::os::http_request Struct Reference

structure that contains all input and output parameters of a http request More...

#include <http_request.h>

Public Attributes

std::string request
 this is the complete request received by the server
 
information of request split into fields
std::string method
 
std::string path
 
std::map< std::string, std::string > params
 
bool authentication_given
 authentication_given is true when the user has entered a username and password.
 
std::string username
 user name of authentification
 
std::string password
 password of authentification
 
std::string accept
 
std::string accept_language
 
std::string accept_encoding
 
std::string user_agent
 
return values
std::string status
 status: used to transmit server's error status, such as
 
std::string auth_realm
 auth_realm: allows to set the basic realm for an authentication, no need to additionally set status if set
 
std::string answer
 set this member to the html page to be returned
 

Detailed Description

structure that contains all input and output parameters of a http request

Definition at line 10 of file http_request.h.

Member Data Documentation

◆ accept

std::string cgv::os::http_request::accept

Definition at line 31 of file http_request.h.

◆ accept_encoding

std::string cgv::os::http_request::accept_encoding

Definition at line 33 of file http_request.h.

◆ accept_language

std::string cgv::os::http_request::accept_language

Definition at line 32 of file http_request.h.

◆ answer

std::string cgv::os::http_request::answer

set this member to the html page to be returned

Definition at line 47 of file http_request.h.

◆ auth_realm

std::string cgv::os::http_request::auth_realm

auth_realm: allows to set the basic realm for an authentication, no need to additionally set status if set

Definition at line 45 of file http_request.h.

◆ authentication_given

bool cgv::os::http_request::authentication_given

authentication_given is true when the user has entered a username and password.

These can then be read from username and password

Definition at line 24 of file http_request.h.

◆ method

std::string cgv::os::http_request::method

Definition at line 17 of file http_request.h.

◆ params

std::map<std::string, std::string> cgv::os::http_request::params

Definition at line 21 of file http_request.h.

◆ password

std::string cgv::os::http_request::password

password of authentification

Definition at line 28 of file http_request.h.

◆ path

std::string cgv::os::http_request::path

Definition at line 19 of file http_request.h.

◆ request

std::string cgv::os::http_request::request

this is the complete request received by the server

Definition at line 13 of file http_request.h.

◆ status

std::string cgv::os::http_request::status

status: used to transmit server's error status, such as

  • 202 OK (this is set by default)
  • 404 Not Found and so on.

Definition at line 42 of file http_request.h.

◆ user_agent

std::string cgv::os::http_request::user_agent

Definition at line 34 of file http_request.h.

◆ username

std::string cgv::os::http_request::username

user name of authentification

Definition at line 26 of file http_request.h.


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