Defines | |
#define | HTTP_HOST_INIT() |
Initializer for structure http_host_t. | |
#define | HTTPTAG_HOST(x) |
Tag list item for pointer to a Host header object. | |
#define | HTTPTAG_HOST_STR(s) |
Tag list item for string with Host header value. | |
Enumerations | |
enum | { http_host_hash } |
Functions | |
http_host_t * | http_host_init (http_host_t x[1]) |
Initialize a structure http_host_t. | |
int | http_is_host (http_header_t const *header) |
Test if header object is instance of http_host_t. | |
http_host_t * | http_host_dup (su_home_t *home, http_host_t const *hdr)) |
Duplicate (deep copy) http_host_t . | |
http_host_t * | http_host_copy (su_home_t *home, http_host_t const *hdr)) |
Copy a http_host_t header structure. | |
http_host_t * | http_host_make (su_home_t *home, char const *s)) |
Make a header structure http_host_t. | |
http_host_t * | http_host_format (su_home_t *home, char const *fmt,...))) |
Make a Host header from formatting result. | |
Variables | |
msg_hclass_t | http_host_class [] |
Header class for HTTP Host header. | |
msg_parse_f | http_host_d |
Decode (parse) a Host header. | |
msg_print_f | http_host_e |
Encode (print) a Host header. |
Host = "Host" ":" host [ ":" port ]
#define HTTP_HOST_INIT | ( | ) |
Initializer for structure http_host_t.
A static http_host_t structure must be initialized with the HTTP_HOST_INIT() macro. For instance,
http_host_t http_host = HTTP_HOST_INIT;
#define HTTPTAG_HOST | ( | x | ) |
Tag list item for pointer to a Host header object.
The HTTPTAG_HOST() macro is used to include a tag item with a pointer to a http_host_t object in a tag list.
x | pointer to a http_host_t header structure, or NULL. |
#define HTTPTAG_HOST_STR | ( | s | ) |
Tag list item for string with Host header value.
The HTTPTAG_HOST_STR() macro is used to include a tag item with a string containing value of a http_host_t header in a tag list.
s | pointer to a string containing http_host_t value, or NULL. |
The HTTPTAG_HOST_STR string can be converted to a http_host_t header structure by giving the string s has second argument to function http_host_make().
http_host_t * http_host_copy | ( | su_home_t * | home, | |
http_host_t const * | hdr | |||
) | [inline] |
Copy a http_host_t header structure.
The function http_host_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.
host = http_host_copy(home, http->http_host);
http_host_t * http_host_dup | ( | su_home_t * | home, | |
http_host_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) http_host_t
.
The function http_host_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.
host = http_host_dup(home, http->http_host);
http_host_t * http_host_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Host header from formatting result.
The function http_host_format() makes a new Host 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 |
http_host_t* http_host_init | ( | http_host_t | x[1] | ) | [inline] |
Initialize a structure http_host_t.
An http_host_t structure can be initialized with the http_host_init() function/macro. For instance,
http_host_t http_host; http_host_init(&http_host);
http_host_t * http_host_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure http_host_t.
The function http_host_make() makes a new http_host_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 |
int http_is_host | ( | http_header_t const * | header | ) | [inline] |
Test if header object is instance of http_host_t.
The function http_is_host() returns true (nonzero) if the header class is an instance of Host header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for HTTP Host header.
The header class http_host_class defines how a HTTP Host header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_host_t header structure.