#include <HttpHeaderFields.h>

Inheritance diagram for HttpHeaderFields:
[legend]

Public Types

enum  Flag { Flag::Multi }
 Flag values providing additional information about header fields. More...
 
using Flags = BitSet< uint8_t, Flag, 1 >
 

Public Member Functions

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 ()
 

Static Public Member Functions

static String toString (const String &name, const String &value)
 Produce a string for output in the HTTP header, with line ending. More...
 

Member Typedef Documentation

◆ Flags

using HttpHeaderFields::Flags = BitSet<uint8_t, Flag, 1>

Member Enumeration Documentation

◆ Flag

Flag values providing additional information about header fields.

Enumerator
Multi 

Field may have multiple values.

Member Function Documentation

◆ clear()

void HttpHeaderFields::clear ( void  )
inline

◆ findOrCreate()

HttpHeaderFieldName HttpHeaderFields::findOrCreate ( const String name)
inline

Find the enumerated value for the given field name string, create a custom entry if not found.

Parameters
name
Return values
HttpHeaderFieldNamefield name code
Note
comparison is not case-sensitive

◆ fromString()

HttpHeaderFieldName HttpHeaderFields::fromString ( const String name) const

Find the enumerated value for the given field name string.

Parameters
name
Return values
HttpHeaderFieldNamefield name code, HTTP_HEADER_UNKNOWN if not recognised
Note
comparison is not case-sensitive

◆ getFlags()

Flags HttpHeaderFields::getFlags ( HttpHeaderFieldName  name) const

Get flags (if any) for given header field.

Return values
Flags

◆ toString() [1/3]

String HttpHeaderFields::toString ( HttpHeaderFieldName  name) const

◆ toString() [2/3]

static String HttpHeaderFields::toString ( const String name,
const String value 
)
static

Produce a string for output in the HTTP header, with line ending.

Parameters
name
value
Return values
String

◆ toString() [3/3]

String HttpHeaderFields::toString ( HttpHeaderFieldName  name,
const String value 
) const

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