pion::http::request Class Reference

`#include <request.hpp>`

Inherits pion::http::message.

## Public Member Functions

| request (const std::string &resource)
| request (void)
| constructs a new request object (default constructor)
virtual | ~request ()
| virtual destructor
virtual void | clear (void)
| clears all request data
virtual bool | is_content_length_implied (void) const
| the content length of the message can never be implied for requests
const std::string & | get_method (void) const
| returns the request method (i.e. GET, POST, PUT)
const std::string & | get_resource (void) const
| returns the resource uri-stem to be delivered (possibly the result of a redirect)
const std::string & | get_original_resource (void) const
| returns the resource uri-stem originally requested
const std::string & | get_query_string (void) const
| returns the uri-query or query string requested
const std::string & | get_query (const std::string &key) const
| returns a value for the query key if any are defined; otherwise, an empty string
ihash_multimap & | get_queries (void)
| returns the query parameters
bool | has_query (const std::string &key) const
| returns true if at least one value for the query key is defined
void | set_method (const std::string &str)
| sets the HTTP request method (i.e. GET, POST, PUT)
void | set_resource (const std::string &str)
| sets the resource or uri-stem originally requested
void | change_resource (const std::string &str)
| changes the resource or uri-stem to be delivered (called as the result of a redirect)
void | set_query_string (const std::string &str)
| sets the uri-query or query string requested
void | add_query (const std::string &key, const std::string &value)
| adds a value for the query key
void | change_query (const std::string &key, const std::string &value)
| changes the value of a query key
void | delete_query (const std::string &key)
| removes all values for a query key
void | use_query_params_for_query_string (void)
| use the query parameters to build a query string for the request
void | use_query_params_for_post_content (void)
| use the query parameters to build POST content for the request
void | set_content (const std::string &value)
| add content (for POST) from string
void | set_content (const char *value, size_t size)
void | set_user (user_ptr user)
| sets the user record for HTTP request after authentication
user_ptr | get_user () const
| get the user record for HTTP request after authentication
Public Member Functions inherited from pion::http::message
| message (void)
| constructs a new HTTP message object
| message (const message &http_msg)
| copy constructor
message & | operator= (const message &http_msg)
| assignment operator
virtual | ~message ()
| virtual destructor
bool | is_valid (void) const
| returns true if the message is valid
bool | get_chunks_supported (void) const
| returns true if chunked transfer encodings are supported
boost::asio::ip::address & | get_remote_ip (void)
| returns IP address of the remote endpoint
boost::uint16_t | get_version_major (void) const
| returns the major HTTP version number
boost::uint16_t | get_version_minor (void) const
| returns the minor HTTP version number
std::string | get_version_string (void) const
| returns a string representation of the HTTP version (i.e. "HTTP/1.1")
size_t | get_content_length (void) const
| returns the length of the payload content (in bytes)
bool | is_chunked (void) const
| returns true if the message content is chunked
bool | is_content_buffer_allocated () const
| returns true if buffer for content is allocated
std::size_t | get_content_buffer_size () const
| returns size of allocated buffer
char * | get_content (void)
| returns a pointer to the payload content, or empty string if there is none
const char * | get_content (void) const
| returns a const pointer to the payload content, or empty string if there is none
chunk_cache_t & | get_chunk_cache (void)
| returns a reference to the chunk cache
const std::string & | get_header (const std::string &key) const
| returns a value for the header if any are defined; otherwise, an empty string
ihash_multimap & | get_headers (void)
| returns a reference to the HTTP headers
bool | has_header (const std::string &key) const
| returns true if at least one value for the header is defined
const std::string & | get_cookie (const std::string &key) const
ihash_multimap & | get_cookies (void)
| returns the cookie parameters
bool | has_cookie (const std::string &key) const
void | add_cookie (const std::string &key, const std::string &value)
void | change_cookie (const std::string &key, const std::string &value)
void | delete_cookie (const std::string &key)
const std::string & | get_first_line (void) const
| returns a string containing the first line for the HTTP message
bool | has_missing_packets () const
| true if there were missing packets
void | set_missing_packets (bool newVal)
| set to true when missing packets detected
bool | has_data_after_missing_packets () const
| true if more data seen after the missing packets
void | set_data_after_missing_packet (bool newVal)
void | set_is_valid (bool b=true)
| sets whether or not the message is valid
void | set_chunks_supported (bool b)
| set to true if chunked transfer encodings are supported
void | set_remote_ip (const boost::asio::ip::address &ip)
| sets IP address of the remote endpoint
void | set_version_major (const boost::uint16_t n)
| sets the major HTTP version number
void | set_version_minor (const boost::uint16_t n)
| sets the minor HTTP version number
void | set_content_length (size_t n)
| sets the length of the payload content (in bytes)
void | set_do_not_send_content_length (void)
| if called, the content-length will not be sent in the HTTP headers
data_status_t | get_status () const
| return the data receival status
void | set_status (data_status_t newVal)
void | update_content_length_using_header (void)
| sets the length of the payload content using the Content-Length header
void | update_transfer_encoding_using_header (void)
| sets the transfer coding using the Transfer-Encoding header
char * | create_content_buffer (void)
void | set_content (const std::string &content)
| resets payload content to match the value of a string
void | clear_content (void)
| clears payload content buffer
void | set_content_type (const std::string &type)
| sets the content type for the message payload
void | add_header (const std::string &key, const std::string &value)
| adds a value for the HTTP header named key
void | change_header (const std::string &key, const std::string &value)
| changes the value for the HTTP header named key
void | delete_header (const std::string &key)
| removes all values for the HTTP header named key
bool | check_keep_alive (void) const
| returns true if the HTTP connection may be kept alive
void | prepare_buffers_for_send (write_buffers_t &write_buffers, const bool keep_alive, const bool using_chunks)
std::size_t | send (tcp::connection &tcp_conn, boost::system::error_code &ec, bool headers_only=false)
std::size_t | receive (tcp::connection &tcp_conn, boost::system::error_code &ec, parser &http_parser)
std::size_t | receive (tcp::connection &tcp_conn, boost::system::error_code &ec, bool headers_only=false, std::size_t max_content_length=static_cast< size_t >(-1))
std::size_t | write (std::ostream &out, boost::system::error_code &ec, bool headers_only=false)
std::size_t | read (std::istream &in, boost::system::error_code &ec, parser &http_parser)
std::size_t | read (std::istream &in, boost::system::error_code &ec, bool headers_only=false, std::size_t max_content_length=static_cast< size_t >(-1))
void | concatenate_chunks (void)
Public Member Functions inherited from pion::http::types
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
Protected Member Functions inherited from pion::http::message
void | prepare_headers_for_send (const bool keep_alive, const bool using_chunks)
void | append_headers (write_buffers_t &write_buffers)
void | clear_first_line (void) const

## Additional Inherited Members

Public Types inherited from pion::http::message
enum | data_status_t { STATUS_NONE, STATUS_TRUNCATED, STATUS_PARTIAL, STATUS_OK }
| defines message data integrity status codes
typedef std::vector< boost::asio::const_buffer > | write_buffers_t
| data type for I/O write buffers (these wrap existing data to be sent)
typedef std::vector< char > | chunk_cache_t
| used to cache chunked data
Static Public Member Functions inherited from pion::http::types
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 Public Attributes inherited from pion::http::types
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
Static Protected Member Functions inherited from pion::http::message
template<typename DictionaryType >
static const std::string & | get_value (const DictionaryType &dict, const std::string &key)
template<typename DictionaryType >
static void | change_value (DictionaryType &dict, const std::string &key, const std::string &value)
template<typename DictionaryType >
static void | delete_value (DictionaryType &dict, const std::string &key)
Protected Attributes inherited from pion::http::message
std::string | m_first_line

## Detailed Description

request: container for HTTP request information

Definition at line 26 of file request.hpp.

## Constructor & Destructor Documentation

## request()

pion::http::request::request | ( | const std::string & | resource | ) |

inline

constructs a new request object

Parameters

  resource | the HTTP resource to request

Definition at line 36 of file request.hpp.

## Member Function Documentation

## set_content()

void pion::http::request::set_content | ( | const char * | value,
|  | size_t | size
| ) |  |

inline

add content (for POST) from buffer of given size does nothing if the buffer is invalid or the buffer size is zero

Definition at line 148 of file request.hpp.

References pion::http::message::create_content_buffer(), and pion::http::message::set_content_length().

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

- include/pion/http/request.hpp