HttpHeaders Class Reference
Encapsulates a set of HTTP header information. More...
#include <HttpHeaders.h>
Inheritance diagram for HttpHeaders:
Collaboration diagram for HttpHeaders:
Classes | |
class | HeaderConst |
class | Iterator |
Public Member Functions | |
HttpHeaders ()=default | |
HttpHeaders (const HttpHeaders &headers) | |
Iterator | begin () const |
Iterator | end () const |
const String & | operator[] (const String &name) const |
Fetch a reference to the header field value by name. More... | |
String & | operator[] (const String &name) |
Fetch a reference to the header field value by name. More... | |
String | operator[] (unsigned index) const |
Return the HTTP header line for the value at the given index. More... | |
template<bool is_const> | |
String | operator[] (const BaseElement< is_const > &elem) const |
bool | contains (const String &name) const |
Determine if given header field is present. More... | |
bool | append (const HttpHeaderFieldName &name, const String &value) |
Append value to multi-value field. More... | |
void | remove (const String &name) |
void | setMultiple (const HttpHeaders &headers) |
HttpHeaders & | operator= (const HttpHeaders &headers) |
void | clear () |
DateTime | getLastModifiedDate () const |
DateTime | getServerDate () const |
bool | contains (const K &key) const |
void | remove (const K &key) |
unsigned int | count () const |
![]() | |
Flags | getFlags (HttpHeaderFieldName name) const |
Get flags (if any) for given header field. More... | |
String | toString (HttpHeaderFieldName name) const |
String | toString (HttpHeaderFieldName name, const String &value) const |
HttpHeaderFieldName | fromString (const String &name) const |
Find the enumerated value for the given field name string. More... | |
HttpHeaderFieldName | findOrCreate (const String &name) |
Find the enumerated value for the given field name string, create a custom entry if not found. More... | |
void | clear () |
Additional Inherited Members | |
![]() | |
enum class | Flag { Multi } |
Flag values providing additional information about header fields. More... | |
using | Flags = BitSet< uint8_t, Flag, 1 > |
![]() | |
static String | toString (const String &name, const String &value) |
Produce a string for output in the HTTP header, with line ending. More... | |
Detailed Description
Encapsulates a set of HTTP header information.
- Note
- fields are stored as a map of field names vs. values. Standard fields may be accessed using enumeration tags. Behaviour is as for HashMap, with the addition of methods to support enumerated field names.
- Todo:
- add name and/or value escaping
Constructor & Destructor Documentation
◆ HttpHeaders() [1/2]
|
default |
◆ HttpHeaders() [2/2]
|
inline |
Member Function Documentation
◆ append()
bool HttpHeaders::append | ( | const HttpHeaderFieldName & | name, |
const String & | value | ||
) |
Append value to multi-value field.
- Parameters
-
name value
- Return values
-
bool false if value exists and field does not permit multiple values
◆ begin()
|
inline |
◆ clear()
|
inline |
◆ contains() [1/2]
|
inline |
◆ contains() [2/2]
|
inline |
Determine if given header field is present.
◆ count()
◆ end()
|
inline |
◆ getLastModifiedDate()
|
inline |
◆ getServerDate()
|
inline |
◆ operator=()
|
inline |
◆ operator[]() [1/4]
template<bool is_const>
|
inline |
◆ operator[]() [2/4]
Fetch a reference to the header field value by name.
- Parameters
-
name
- Return values
-
String& Reference to value
- Note
- if the field doesn't exist it is created with the default null value
◆ operator[]() [3/4]
◆ operator[]() [4/4]
Return the HTTP header line for the value at the given index.
- Parameters
-
index
- Return values
-
String
- Note
- if the index is invalid,
◆ remove() [1/2]
|
inline |
◆ remove() [2/2]
|
inline |
◆ setMultiple()
void HttpHeaders::setMultiple | ( | const HttpHeaders & | headers | ) |
The documentation for this class was generated from the following file: