Req/Resp headers common data. More...
#include <http_headers.hpp>
Inheritance diagram for restinio::http_header_common_t:
Public Member Functions | |
| std::uint64_t | content_length () const noexcept |
| Length of body of an http-message. More... | |
| void | content_length (std::uint64_t l) noexcept |
| bool | should_keep_alive () const noexcept |
| void | should_keep_alive (bool keep_alive) noexcept |
| http_connection_header_t | connection () const |
| Get the value of 'connection' header field. More... | |
| void | connection (http_connection_header_t ch) noexcept |
| Set the value of 'connection' header field. More... | |
| std::uint16_t | http_major () const noexcept |
| Http version. More... | |
| void | http_major (std::uint16_t v) noexcept |
| std::uint16_t | http_minor () const noexcept |
| void | http_minor (std::uint16_t v) noexcept |
 Public Member Functions inherited from restinio::http_header_fields_t | |
| http_header_fields_t () | |
| http_header_fields_t (const http_header_fields_t &)=default | |
| http_header_fields_t (http_header_fields_t &&)=default | |
| virtual | ~http_header_fields_t () |
| http_header_fields_t & | operator= (const http_header_fields_t &)=default |
| http_header_fields_t & | operator= (http_header_fields_t &&)=default |
| void | swap_fields (http_header_fields_t &http_header_fields) |
| bool | has_field (string_view_t field_name) const noexcept |
| Check field by name. More... | |
| bool | has_field (http_field_t field_id) const noexcept |
| Check field by field-id. More... | |
| void | set_field (http_header_field_t http_header_field) |
| Set header field via http_header_field_t. More... | |
| void | set_field (std::string field_name, std::string field_value) |
| Set field with string pair. More... | |
| void | set_field (http_field_t field_id, std::string field_value) |
| Set field with id-value pair. More... | |
| void | add_field (http_field_t field_id, std::string field_value) |
| Add a field in the form of id-value pair. More... | |
| void | add_field (std::string field_name, std::string field_value) |
| Add a field in the form of name-value pair. More... | |
| void | add_field (http_header_field_t http_header_field) |
| Add a field in the form of http_header_field object. More... | |
| void | append_field (string_view_t field_name, string_view_t field_value) |
| Append field with name. More... | |
| void | append_field (http_field_t field_id, string_view_t field_value) |
| Append field with id. More... | |
| const std::string & | get_field (string_view_t field_name) const |
| Get field by name. More... | |
| nullable_pointer_t< const std::string > | try_get_field (string_view_t field_name) const noexcept |
| Try to get the value of a field by field name. More... | |
| const std::string & | get_field (http_field_t field_id) const |
| Get field by id. More... | |
| nullable_pointer_t< const std::string > | try_get_field (http_field_t field_id) const noexcept |
| Try to get the value of a field by field ID. More... | |
| std::string | get_field_or (string_view_t field_name, string_view_t default_value) const |
| Get field value by field name or default value if the field not found. More... | |
| std::string | get_field_or (string_view_t field_name, std::string &&default_value) const |
| Get field value by field name or default value if the field not found. More... | |
| auto | get_field_or (string_view_t field_name, const char *default_value) const |
| Get field by name or default value if the field not found. More... | |
| auto | get_field_or (string_view_t field_name, const std::string &default_value) const |
| Get field by name or default value if the field not found. More... | |
| std::string | get_field_or (http_field_t field_id, string_view_t default_value) const |
| Get field by id or default value if the field not found. More... | |
| auto | get_field_or (http_field_t field_id, const char *default_value) const |
| Get field by id or default value if the field not found. More... | |
| auto | get_field_or (http_field_t field_id, const std::string &default_value) const |
| Get field by id or default value if the field not found. More... | |
| std::string | get_field_or (http_field_t field_id, std::string &&default_value) const |
| Get field by id or default value if the field not found. More... | |
| bool | remove_field (string_view_t field_name) noexcept |
| Remove field by name. More... | |
| bool | remove_field (http_field_t field_id) noexcept |
| Remove field by id. More... | |
| std::size_t | remove_all_of (string_view_t field_name) noexcept |
| Remove all occurences of a field with specified name. More... | |
| std::size_t | remove_all_of (http_field_t field_id) noexcept |
| Remove all occurences of a field with specified id. More... | |
| template<typename Lambda > | |
| void | for_each_field (Lambda &&lambda) const noexcept(noexcept(lambda(std::declval< const http_header_field_t &>()))) |
| Enumeration of fields. More... | |
| template<typename Lambda > | |
| void | for_each_value_of (http_field_t field_id, Lambda &&lambda) const noexcept(noexcept(lambda(std::declval< const string_view_t &>()))) |
| Enumeration of each value of a field. More... | |
| template<typename Lambda > | |
| void | for_each_value_of (string_view_t field_name, Lambda &&lambda) const noexcept(noexcept(lambda(std::declval< const string_view_t &>()))) |
| Enumeration of each value of a field. More... | |
| const_iterator | begin () const noexcept |
| const_iterator | end () const noexcept |
| auto | fields_count () const noexcept |
| string_view_t | value_of (string_view_t name) const |
| Get the value of a field or throw if the field not found. More... | |
| string_view_t | value_of (http_field_t field_id) const |
| Get the value of a field or throw if the field not found. More... | |
| optional_t< string_view_t > | opt_value_of (string_view_t name) const noexcept |
| Get optional value of a field. More... | |
| optional_t< string_view_t > | opt_value_of (http_field_t field_id) const noexcept |
| Get optional value of a field. More... | |
Private Attributes | |
| std::uint64_t | m_content_length { 0 } |
| Length of body of an http-message. More... | |
| http_connection_header_t | m_http_connection_header_field_value { http_connection_header_t::close } |
| std::uint16_t | m_http_major {1} |
| Http version. More... | |
| std::uint16_t | m_http_minor {1} |
Additional Inherited Members | |
| Public Types inherited from restinio::http_header_fields_t | |
| enum | handling_result_t { handling_result_t::continue_enumeration, handling_result_t::stop_enumeration } |
| The result of handling yet another field value. More... | |
| using | fields_container_t = std::vector< http_header_field_t > |
| using | const_iterator = fields_container_t::const_iterator |
| Type of const_iterator for enumeration of fields. More... | |
| Static Public Member Functions inherited from restinio::http_header_fields_t | |
| static constexpr handling_result_t | continue_enumeration () noexcept |
| static constexpr handling_result_t | stop_enumeration () noexcept |
Detailed Description
Req/Resp headers common data.
Definition at line 1578 of file http_headers.hpp.
Member Function Documentation
◆ connection() [1/2]
|
inline |
Get the value of 'connection' header field.
Definition at line 1626 of file http_headers.hpp.
◆ connection() [2/2]
|
inlinenoexcept |
Set the value of 'connection' header field.
Definition at line 1633 of file http_headers.hpp.
◆ content_length() [1/2]
|
inlinenoexcept |
Length of body of an http-message.
Definition at line 1603 of file http_headers.hpp.
◆ content_length() [2/2]
|
inlinenoexcept |
Definition at line 1607 of file http_headers.hpp.
◆ http_major() [1/2]
|
inlinenoexcept |
Http version.
Definition at line 1585 of file http_headers.hpp.
◆ http_major() [2/2]
|
inlinenoexcept |
Definition at line 1589 of file http_headers.hpp.
◆ http_minor() [1/2]
|
inlinenoexcept |
Definition at line 1593 of file http_headers.hpp.
◆ http_minor() [2/2]
|
inlinenoexcept |
Definition at line 1597 of file http_headers.hpp.
◆ should_keep_alive() [1/2]
|
inlinenoexcept |
Definition at line 1611 of file http_headers.hpp.
◆ should_keep_alive() [2/2]
|
inlinenoexcept |
Definition at line 1617 of file http_headers.hpp.
Member Data Documentation
◆ m_content_length
|
private |
Length of body of an http-message.
Definition at line 1646 of file http_headers.hpp.
◆ m_http_connection_header_field_value
|
private |
Definition at line 1648 of file http_headers.hpp.
◆ m_http_major
|
private |
Http version.
Definition at line 1641 of file http_headers.hpp.
◆ m_http_minor
|
private |
Definition at line 1642 of file http_headers.hpp.
The documentation for this struct was generated from the following file:
- restinio/http_headers.hpp
