websocketpp::http::parser::parser Class Reference

Base HTTP parser. More...

#include <parser.hpp>

Inheritance diagram for websocketpp::http::parser::parser:

Collaboration diagram for websocketpp::http::parser::parser:

Public Member Functions
	parser ()
std::string const &	get_version () const
	Get the HTTP version string.
void	set_version (std::string const &version)
	Set HTTP parser Version.
std::string const &	get_header (std::string const &key) const
	Get the value of an HTTP header.
bool	get_header_as_plist (std::string const &key, parameter_list &out) const
	Extract an HTTP parameter list from a parser header.
void	append_header (std::string const &key, std::string const &val)
	Append a value to an existing HTTP header.
void	replace_header (std::string const &key, std::string const &val)
	Set a value for an HTTP header, replacing an existing value.
void	remove_header (std::string const &key)
	Remove a header from the parser.
std::string const &	get_body () const
	Get HTTP body.
void	set_body (std::string const &value)
	Set body content.
size_t	get_max_body_size () const
	Get body size limit.
void	set_max_body_size (size_t value)
	Set body size limit.
bool	parse_parameter_list (std::string const &in, parameter_list &out) const
	Extract an HTTP parameter list from a string.

Protected Member Functions
void	process_header (std::string::iterator begin, std::string::iterator end)
	Process a header line.
bool	prepare_body ()
	Prepare the parser to begin parsing body data.
size_t	process_body (char const *buf, size_t len)
	Process body data.
bool	body_ready () const
	Check if the parser is done parsing the body.
std::string	raw_headers () const
	Generate and return the HTTP headers as a string.

Protected Attributes
std::string	m_version
header_list	m_headers
size_t	m_header_bytes
std::string	m_body
size_t	m_body_bytes_needed
size_t	m_body_bytes_max
body_encoding::value	m_body_encoding

Detailed Description

Includes methods and data elements common to all types of HTTP messages such as headers, versions, bodies, etc.

Definition at line 398 of file parser.hpp.

Constructor & Destructor Documentation

parser()

websocketpp::http::parser::parser::parser ( )

inline

Definition at line 400 of file parser.hpp.

      : m_header_bytes(0)
      , m_body_bytes_needed(0)
      , m_body_bytes_max(max_body_size)
      , m_body_encoding(body_encoding::unknown) {}

Member Function Documentation

append_header()

void websocketpp::http::parser::parser::append_header ( std::string const & key, std::string const & val )

inline

This method will set the value of the HTTP header key with the indicated value. If a header with the name key already exists, val will be appended to the existing value.

Todo

Make this method case insensitive.

Should there be any restrictions on which keys are allowed?

Exception free varient

See also

replace_header

Parameters

[in]	key	The name/key of the header to append to.
[in]	val	The value to append.

Definition at line 67 of file parser.hpp.

{
    if (std::find_if(key.begin(),key.end(),is_not_token_char) != key.end()) {
        throw exception("Invalid header name",status_code::bad_request);
    }
 
    if (this->get_header(key).empty()) {
        m_headers[key] = val;
    } else {
        m_headers[key] += ", " + val;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

body_ready()

bool websocketpp::http::parser::parser::body_ready ( ) const

inlineprotected

Behavior before a call to prepare_body is undefined.

Since

0.5.0

Returns

True if the message body has been completed loaded.

Definition at line 589 of file parser.hpp.

                            {
        return (m_body_bytes_needed == 0);
    }

Here is the caller graph for this function:

get_body()

std::string const & websocketpp::http::parser::parser::get_body ( ) const

inline

Gets the body of the HTTP object

Returns

The body of the HTTP message.

Definition at line 495 of file parser.hpp.

                                       {
        return m_body;
    }

get_header()

std::string const & websocketpp::http::parser::parser::get_header ( std::string const & key ) const

inline

Todo

Make this method case insensitive.

Parameters

[in]

key

The name/key of the header to get.

Returns

The value associated with the given HTTP header key.

Definition at line 45 of file parser.hpp.

                                                                       {
    header_list::const_iterator h = m_headers.find(key);
 
    if (h == m_headers.end()) {
        return empty_header;
    } else {
        return h->second;
    }
}

Here is the caller graph for this function:

get_header_as_plist()

bool websocketpp::http::parser::parser::get_header_as_plist ( std::string const & key, parameter_list & out ) const

inline

If the header requested doesn't exist or exists and is empty the parameter list is valid (but empty).

Parameters

[in]	key	The name/key of the HTTP header to use as input.
[out]	out	The parameter list to store extracted parameters in.

Returns

Whether or not the input was a valid parameter list.

Definition at line 55 of file parser.hpp.

{
    header_list::const_iterator it = m_headers.find(key);
 
    if (it == m_headers.end() || it->second.size() == 0) {
        return false;
    }
 
    return this->parse_parameter_list(it->second,out);
}

Here is the call graph for this function:

get_max_body_size()

size_t websocketpp::http::parser::parser::get_max_body_size ( ) const

inline

Retrieves the maximum number of bytes to parse & buffer before canceling a request.

Since

0.5.0

Returns

The maximum length of a message body.

Definition at line 519 of file parser.hpp.

                                     {
        return m_body_bytes_max;
    }

get_version()

std::string const & websocketpp::http::parser::parser::get_version ( ) const

inline

Returns

The version string for this parser

Definition at line 410 of file parser.hpp.

                                          {
        return m_version;
    }

Here is the caller graph for this function:

parse_parameter_list()

bool websocketpp::http::parser::parser::parse_parameter_list ( std::string const & in, parameter_list & out ) const

inline

Parameters

[in]	in	The input string.
[out]	out	The parameter list to store extracted parameters in.

Returns

Whether or not the input was a valid parameter list.

Definition at line 107 of file parser.hpp.

{
    if (in.size() == 0) {
        return false;
    }
 
    std::string::const_iterator it;
    it = extract_parameters(in.begin(),in.end(),out);
    return (it == in.begin());
}

Here is the call graph for this function:

Here is the caller graph for this function:

prepare_body()

bool websocketpp::http::parser::parser::prepare_body ( )

inlineprotected

Inspects headers to determine if the message has a body that needs to be read. If so, sets up the necessary state, otherwise returns false. If this method returns true and loading the message body is desired call process_body until it returns zero bytes or an error.

Must not be called until after all headers have been processed.

Since

0.5.0

Returns

True if more bytes are needed to load the body, false otherwise.

Definition at line 119 of file parser.hpp.

                                 {
    if (!get_header("Content-Length").empty()) {
        std::string const & cl_header = get_header("Content-Length");
        char * end;
        
        // TODO: not 100% sure what the compatibility of this method is. Also,
        // I believe this will only work up to 32bit sizes. Is there a need for
        // > 4GiB HTTP payloads?
        m_body_bytes_needed = std::strtoul(cl_header.c_str(),&end,10);
        
        if (m_body_bytes_needed > m_body_bytes_max) {
            throw exception("HTTP message body too large",
                status_code::request_entity_too_large);
        }
        
        m_body_encoding = body_encoding::plain;
        return true;
    } else if (get_header("Transfer-Encoding") == "chunked") {
        // TODO
        //m_body_encoding = body_encoding::chunked;
        return false;
    } else {
        return false;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

process_body()

size_t websocketpp::http::parser::parser::process_body ( char const * buf, size_t len )

inlineprotected

Parses body data.

Since

0.5.0

Parameters

[in]	begin	An iterator to the beginning of the sequence.
[in]	end	An iterator to the end of the sequence.

Returns

The number of bytes processed

Definition at line 145 of file parser.hpp.

                                                               {
    if (m_body_encoding == body_encoding::plain) {
        size_t processed = (std::min)(m_body_bytes_needed,len);
        m_body.append(buf,processed);
        m_body_bytes_needed -= processed;
        return processed;
    } else if (m_body_encoding == body_encoding::chunked) {
        // TODO: 
        throw exception("Unexpected body encoding",
            status_code::internal_server_error);
    } else {
        throw exception("Unexpected body encoding",
            status_code::internal_server_error);
    }
}

Here is the caller graph for this function:

process_header()

void websocketpp::http::parser::parser::process_header ( std::string::iterator begin, std::string::iterator end )

inlineprotected

Todo

Update this method to be exception free.

Parameters

[in]	begin	An iterator to the beginning of the sequence.
[in]	end	An iterator to the end of the sequence.

Definition at line 161 of file parser.hpp.

{
    std::string::iterator cursor = std::search(
        begin,
        end,
        header_separator,
        header_separator + sizeof(header_separator) - 1
    );
 
    if (cursor == end) {
        throw exception("Invalid header line",status_code::bad_request);
    }
 
    append_header(strip_lws(std::string(begin,cursor)),
                  strip_lws(std::string(cursor+sizeof(header_separator)-1,end)));
}

Here is the call graph for this function:

Here is the caller graph for this function:

raw_headers()

std::string websocketpp::http::parser::parser::raw_headers ( ) const

inlineprotected

Each headers will be followed by the \r
sequence including the last one. A second \r
sequence (blank header) is not appended by this method

Returns

The HTTP headers as a string.

Definition at line 179 of file parser.hpp.

                                           {
    std::stringstream raw;
 
    header_list::const_iterator it;
    for (it = m_headers.begin(); it != m_headers.end(); it++) {
        raw << it->first << ": " << it->second << "\r\n";
    }
 
    return raw.str();
}

Here is the caller graph for this function:

remove_header()

void websocketpp::http::parser::parser::remove_header ( std::string const & key )

inline

Removes the header entirely from the parser. This is different than setting the value of the header to blank.

Todo

Make this method case insensitive.

Parameters

[in]

key

The name/key of the header to remove.

Definition at line 87 of file parser.hpp.

                                                       {
    m_headers.erase(key);
}

Here is the caller graph for this function:

replace_header()

void websocketpp::http::parser::parser::replace_header ( std::string const & key, std::string const & val )

inline

This method will set the value of the HTTP header key with the indicated value. If a header with the name key already exists, val will replace the existing value.

Todo

Make this method case insensitive.

Should there be any restrictions on which keys are allowed?

Exception free varient

See also

append_header

Parameters

[in]	key	The name/key of the header to append to.
[in]	val	The value to append.

Definition at line 81 of file parser.hpp.

{
    m_headers[key] = val;
}

Here is the caller graph for this function:

set_body()

void websocketpp::http::parser::parser::set_body ( std::string const & value )

inline

Set the body content of the HTTP response to the parameter string. Note set_body will also set the Content-Length HTTP header to the appropriate value. If you want the Content-Length header to be something else, do so via replace_header("Content-Length") after calling set_body()

Parameters

value

String data to include as the body content.

Definition at line 91 of file parser.hpp.

                                                    {
    if (value.size() == 0) {
        remove_header("Content-Length");
        m_body.clear();
        return;
    }
 
    // TODO: should this method respect the max size? If so how should errors
    // be indicated?
 
    std::stringstream len;
    len << value.size();
    replace_header("Content-Length", len.str());
    m_body = value;
}

Here is the call graph for this function:

set_max_body_size()

void websocketpp::http::parser::parser::set_max_body_size ( size_t value )

inline

Set the maximum number of bytes to parse and buffer before canceling a request.

Since

0.5.0

Parameters

value

The size to set the max body length to.

Definition at line 532 of file parser.hpp.

                                         {
        m_body_bytes_max = value;
    }

set_version()

void websocketpp::http::parser::parser::set_version ( std::string const & version )

inline

Input should be in format: HTTP/x.y where x and y are positive integers.

Todo

Does this method need any validation?

Parameters

[in]

version

The value to set the HTTP version to.

Definition at line 41 of file parser.hpp.

                                                         {
    m_version = version;
}

Member Data Documentation

m_body

std::string websocketpp::http::parser::parser::m_body

protected

Definition at line 607 of file parser.hpp.

m_body_bytes_max

size_t websocketpp::http::parser::parser::m_body_bytes_max

protected

Definition at line 609 of file parser.hpp.

m_body_bytes_needed

size_t websocketpp::http::parser::parser::m_body_bytes_needed

protected

Definition at line 608 of file parser.hpp.

m_body_encoding

body_encoding::value websocketpp::http::parser::parser::m_body_encoding

protected

Definition at line 610 of file parser.hpp.

m_header_bytes

size_t websocketpp::http::parser::parser::m_header_bytes

protected

Definition at line 605 of file parser.hpp.

m_headers

header_list websocketpp::http::parser::parser::m_headers

protected

Definition at line 603 of file parser.hpp.

m_version

std::string websocketpp::http::parser::parser::m_version

protected

Definition at line 602 of file parser.hpp.

---

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

• libraries/fc/vendor/websocketpp/websocketpp/http/parser.hpp
• libraries/fc/vendor/websocketpp/websocketpp/http/impl/parser.hpp