pion
5.0.6
|
#include <response.hpp>
Inherits pion::http::message.
Public Member Functions | |
response (const http::request &http_request_ptr) | |
response (const std::string &request_method) | |
response (const response &http_response) | |
copy constructor | |
response (void) | |
virtual | ~response () |
virtual destructor | |
virtual void | clear (void) |
clears all response data | |
virtual bool | is_content_length_implied (void) const |
the content length may be implied for certain types of responses | |
void | update_request_info (const http::request &http_request) |
void | set_status_code (unsigned int n) |
sets the HTTP response status code | |
void | set_status_message (const std::string &msg) |
sets the HTTP response status message | |
unsigned int | get_status_code (void) const |
returns the HTTP response status code | |
const std::string & | get_status_message (void) const |
returns the HTTP response status message | |
void | set_cookie (const std::string &name, const std::string &value) |
void | set_cookie (const std::string &name, const std::string &value, const std::string &path) |
void | set_cookie (const std::string &name, const std::string &value, const std::string &path, const unsigned long max_age) |
void | set_cookie (const std::string &name, const std::string &value, const unsigned long max_age) |
void | delete_cookie (const std::string &name) |
deletes cookie called name by adding a Set-Cookie header (cookie has no path) | |
void | delete_cookie (const std::string &name, const std::string &path) |
deletes cookie called name by adding a Set-Cookie header (cookie has a path) | |
void | set_last_modified (const unsigned long t) |
sets the time that the response was last modified (Last-Modified) | |
![]() | |
virtual | ~types () |
virtual destructor | |
Protected Member Functions | |
virtual void | update_first_line (void) const |
updates the string containing the first line for the HTTP message | |
virtual void | append_cookie_headers (void) |
appends HTTP headers for any cookies defined by the http::message | |
Additional Inherited Members | |
defines message data integrity status codes | |
![]() | |
static std::string | get_date_string (const time_t t) |
converts time_t format into an HTTP-date string | |
static std::string | make_query_string (const ihash_multimap &query_params) |
builds an HTTP query string from a collection of query parameters | |
static std::string | make_set_cookie_header (const std::string &name, const std::string &value, const std::string &path, const bool has_max_age=false, const unsigned long max_age=0) |
![]() | |
static const std::string | STRING_EMPTY |
static const std::string | STRING_CRLF |
static const std::string | STRING_HTTP_VERSION |
static const std::string | HEADER_NAME_VALUE_DELIMITER |
static const std::string | COOKIE_NAME_VALUE_DELIMITER |
static const std::string | HEADER_HOST |
static const std::string | HEADER_COOKIE |
static const std::string | HEADER_SET_COOKIE |
static const std::string | HEADER_CONNECTION |
static const std::string | HEADER_CONTENT_TYPE |
static const std::string | HEADER_CONTENT_LENGTH |
static const std::string | HEADER_CONTENT_LOCATION |
static const std::string | HEADER_CONTENT_ENCODING |
static const std::string | HEADER_CONTENT_DISPOSITION |
static const std::string | HEADER_LAST_MODIFIED |
static const std::string | HEADER_IF_MODIFIED_SINCE |
static const std::string | HEADER_TRANSFER_ENCODING |
static const std::string | HEADER_LOCATION |
static const std::string | HEADER_AUTHORIZATION |
static const std::string | HEADER_REFERER |
static const std::string | HEADER_USER_AGENT |
static const std::string | HEADER_X_FORWARDED_FOR |
static const std::string | HEADER_CLIENT_IP |
static const std::string | CONTENT_TYPE_HTML |
static const std::string | CONTENT_TYPE_TEXT |
static const std::string | CONTENT_TYPE_XML |
static const std::string | CONTENT_TYPE_URLENCODED |
static const std::string | CONTENT_TYPE_MULTIPART_FORM_DATA |
static const std::string | REQUEST_METHOD_HEAD |
static const std::string | REQUEST_METHOD_GET |
static const std::string | REQUEST_METHOD_PUT |
static const std::string | REQUEST_METHOD_POST |
static const std::string | REQUEST_METHOD_DELETE |
static const std::string | RESPONSE_MESSAGE_OK |
static const std::string | RESPONSE_MESSAGE_CREATED |
static const std::string | RESPONSE_MESSAGE_ACCEPTED |
static const std::string | RESPONSE_MESSAGE_NO_CONTENT |
static const std::string | RESPONSE_MESSAGE_FOUND |
static const std::string | RESPONSE_MESSAGE_UNAUTHORIZED |
static const std::string | RESPONSE_MESSAGE_FORBIDDEN |
static const std::string | RESPONSE_MESSAGE_NOT_FOUND |
static const std::string | RESPONSE_MESSAGE_METHOD_NOT_ALLOWED |
static const std::string | RESPONSE_MESSAGE_NOT_MODIFIED |
static const std::string | RESPONSE_MESSAGE_BAD_REQUEST |
static const std::string | RESPONSE_MESSAGE_SERVER_ERROR |
static const std::string | RESPONSE_MESSAGE_NOT_IMPLEMENTED |
static const std::string | RESPONSE_MESSAGE_CONTINUE |
static const unsigned int | RESPONSE_CODE_OK = 200 |
static const unsigned int | RESPONSE_CODE_CREATED = 201 |
static const unsigned int | RESPONSE_CODE_ACCEPTED = 202 |
static const unsigned int | RESPONSE_CODE_NO_CONTENT = 204 |
static const unsigned int | RESPONSE_CODE_FOUND = 302 |
static const unsigned int | RESPONSE_CODE_UNAUTHORIZED = 401 |
static const unsigned int | RESPONSE_CODE_FORBIDDEN = 403 |
static const unsigned int | RESPONSE_CODE_NOT_FOUND = 404 |
static const unsigned int | RESPONSE_CODE_METHOD_NOT_ALLOWED = 405 |
static const unsigned int | RESPONSE_CODE_NOT_MODIFIED = 304 |
static const unsigned int | RESPONSE_CODE_BAD_REQUEST = 400 |
static const unsigned int | RESPONSE_CODE_SERVER_ERROR = 500 |
static const unsigned int | RESPONSE_CODE_NOT_IMPLEMENTED = 501 |
static const unsigned int | RESPONSE_CODE_CONTINUE = 100 |
response: container for HTTP response information
Definition at line 27 of file response.hpp.
|
inline |
constructs a new response object for a particular request
http_request_ptr | the request that this is responding to |
Definition at line 37 of file response.hpp.
References update_request_info().
|
inline |
constructs a new response object for a particular request method
request_method | the method used by the HTTP request we are responding to |
Definition at line 49 of file response.hpp.
|
inline |
default constructor: you are strongly encouraged to use one of the other constructors, since response parsing is influenced by the request method
Definition at line 64 of file response.hpp.
|
inline |
sets a cookie by adding a Set-Cookie header (see RFC 2109) the cookie will be discarded by the user-agent when it closes
name | the name of the cookie |
value | the value of the cookie |
Definition at line 134 of file response.hpp.
References pion::http::message::add_header(), and pion::http::types::make_set_cookie_header().
Referenced by append_cookie_headers().
|
inline |
sets a cookie by adding a Set-Cookie header (see RFC 2109) the cookie will be discarded by the user-agent when it closes
name | the name of the cookie |
value | the value of the cookie |
path | the path of the cookie |
Definition at line 147 of file response.hpp.
References pion::http::message::add_header(), and pion::http::types::make_set_cookie_header().
|
inline |
sets a cookie by adding a Set-Cookie header (see RFC 2109)
name | the name of the cookie |
value | the value of the cookie |
path | the path of the cookie |
max_age | the life of the cookie, in seconds (0 = discard) |
Definition at line 162 of file response.hpp.
References pion::http::message::add_header(), and pion::http::types::make_set_cookie_header().
|
inline |
sets a cookie by adding a Set-Cookie header (see RFC 2109)
name | the name of the cookie |
value | the value of the cookie |
max_age | the life of the cookie, in seconds (0 = discard) |
Definition at line 176 of file response.hpp.
References pion::http::message::add_header(), and pion::http::types::make_set_cookie_header().
|
inline |
Updates HTTP request information for the response object (use this if the response cannot be constructed using the request)
http_request | the request that this is responding to |
Definition at line 95 of file response.hpp.
References pion::http::request::get_method(), pion::http::message::get_version_major(), pion::http::message::get_version_minor(), pion::http::message::set_chunks_supported(), set_status_code(), set_status_message(), pion::http::message::set_version_major(), and pion::http::message::set_version_minor().
Referenced by response().