http
1.13.17
|
Macros | |
#define | HTTP_SEC_WEBSOCKET_KEY_INIT() |
Initializer for structure http_sec_websocket_key_t. More... | |
#define | HTTPTAG_SEC_WEBSOCKET_KEY(x) |
Tag list item for pointer to a Sec-Websocket-Key header object. More... | |
#define | HTTPTAG_SEC_WEBSOCKET_KEY_STR(s) |
Tag list item for string with Sec-Websocket-Key header value. More... | |
Enumerations | |
enum | { http_sec_websocket_key_hash } |
Functions | |
http_sec_websocket_key_t * | http_sec_websocket_key_init (http_sec_websocket_key_t x[1]) |
Initialize a structure http_sec_websocket_key_t. More... | |
int | http_is_sec_websocket_key (http_header_t const *header) |
Test if header object is instance of http_sec_websocket_key_t. More... | |
http_sec_websocket_key_t * | http_sec_websocket_key_dup (su_home_t *home, http_sec_websocket_key_t const *hdr)) |
Duplicate (deep copy) http_sec_websocket_key_t . More... | |
http_sec_websocket_key_t * | http_sec_websocket_key_copy (su_home_t *home, http_sec_websocket_key_t const *hdr)) |
Copy a http_sec_websocket_key_t header structure. More... | |
http_sec_websocket_key_t * | http_sec_websocket_key_make (su_home_t *home, char const *s)) |
Make a header structure http_sec_websocket_key_t. More... | |
http_sec_websocket_key_t * | http_sec_websocket_key_format (su_home_t *home, char const *fmt,...))) |
Make a Sec-Websocket-Key header from formatting result. More... | |
Variables | |
msg_hclass_t | http_sec_websocket_key_class [] |
Header class for HTTP Sec-Websocket-Key header. More... | |
msg_parse_f | http_sec_websocket_key_d |
Decode (parse) a Sec-Websocket-Key header. | |
msg_print_f | http_sec_websocket_key_e |
Encode (print) a Sec-Websocket-Key header. | |
#define HTTP_SEC_WEBSOCKET_KEY_INIT | ( | ) |
Initializer for structure http_sec_websocket_key_t.
A static http_sec_websocket_key_t structure must be initialized with the HTTP_SEC_WEBSOCKET_KEY_INIT() macro. For instance,
#define HTTPTAG_SEC_WEBSOCKET_KEY | ( | x | ) |
Tag list item for pointer to a Sec-Websocket-Key header object.
The HTTPTAG_SEC_WEBSOCKET_KEY() macro is used to include a tag item with a pointer to a http_sec_websocket_key_t object in a tag list.
x | pointer to a http_sec_websocket_key_t header structure, or NULL. |
#define HTTPTAG_SEC_WEBSOCKET_KEY_STR | ( | s | ) |
Tag list item for string with Sec-Websocket-Key header value.
The HTTPTAG_SEC_WEBSOCKET_KEY_STR() macro is used to include a tag item with a string containing value of a http_sec_websocket_key_t header in a tag list.
s | pointer to a string containing http_sec_websocket_key_t value, or NULL. |
The HTTPTAG_SEC_WEBSOCKET_KEY_STR string can be converted to a http_sec_websocket_key_t header structure by giving the string s has second argument to function http_sec_websocket_key_make().
|
inline |
Test if header object is instance of http_sec_websocket_key_t.
The function http_is_sec_websocket_key() returns true (nonzero) if the header class is an instance of Sec-Websocket-Key header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
|
inline |
Copy a http_sec_websocket_key_t header structure.
The function http_sec_websocket_key_copy() copies a header structure hdr. If the header structure hdr contains a reference (hdr->h_next
) to a list of headers, all the headers in that list are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header structure hdr.
home | memory home used to allocate new structure |
hdr | pointer to the header structure to be duplicated |
When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old header, including the encoding of the old header, if present.
|
inline |
Duplicate (deep copy) http_sec_websocket_key_t
.
The function http_sec_websocket_key_dup() duplicates a header structure hdr. If the header structure hdr contains a reference (hdr->x_next
) to a list of headers, all the headers in the list are duplicated, too.
home | memory home used to allocate new structure |
hdr | header structure to be duplicated |
When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.
|
inline |
Make a Sec-Websocket-Key header from formatting result.
The function http_sec_websocket_key_format() makes a new Sec-Websocket-Key header object using formatting result as its value. The function first prints the arguments according to the format fmt specified. Then it allocates a new header structure, and uses the formatting result as the header value.
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
|
inline |
Initialize a structure http_sec_websocket_key_t.
An http_sec_websocket_key_t structure can be initialized with the http_sec_websocket_key_init() function/macro. For instance,
|
inline |
Make a header structure http_sec_websocket_key_t.
The function http_sec_websocket_key_make() makes a new http_sec_websocket_key_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
home | memory home used to allocate new header structure. |
s | string to be decoded as value of the new header structure |
|
extern |
Header class for HTTP Sec-Websocket-Key header.
The header class http_sec_websocket_key_class defines how a HTTP Sec-Websocket-Key header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_sec_websocket_key_t header structure.