We use MIME Content-Location header. More...
Defines | |
#define | HTTP_CONTENT_LOCATION_INIT() |
Initializer for structure http_content_location_t. | |
#define | HTTPTAG_CONTENT_LOCATION(x) |
Tag list item for pointer to a Content-Location header object. | |
#define | HTTPTAG_CONTENT_LOCATION_STR(s) |
Tag list item for string with Content-Location header value. | |
Enumerations | |
enum | { http_content_location_hash } |
Functions | |
http_content_location_t * | http_content_location_init (http_content_location_t x[1]) |
Initialize a structure http_content_location_t. | |
int | http_is_content_location (http_header_t const *header) |
Test if header object is instance of http_content_location_t. | |
http_content_location_t * | http_content_location_dup (su_home_t *home, http_content_location_t const *hdr)) |
Duplicate (deep copy) http_content_location_t . | |
http_content_location_t * | http_content_location_copy (su_home_t *home, http_content_location_t const *hdr)) |
Copy a http_content_location_t header structure. | |
http_content_location_t * | http_content_location_make (su_home_t *home, char const *s)) |
Make a header structure http_content_location_t. | |
http_content_location_t * | http_content_location_format (su_home_t *home, char const *fmt,...))) |
Make a Content-Location header from formatting result. | |
Variables | |
msg_hclass_t | http_content_location_class [] |
Header class for HTTP Content-Location header. | |
msg_parse_f | http_content_location_d |
Decode (parse) a Content-Location header. | |
msg_print_f | http_content_location_e |
Encode (print) a Content-Location header. |
We use MIME Content-Location header.
#define HTTP_CONTENT_LOCATION_INIT | ( | ) |
Initializer for structure http_content_location_t.
A static http_content_location_t structure must be initialized with the HTTP_CONTENT_LOCATION_INIT() macro. For instance,
http_content_location_t http_content_location = HTTP_CONTENT_LOCATION_INIT;
#define HTTPTAG_CONTENT_LOCATION | ( | x | ) |
Tag list item for pointer to a Content-Location header object.
The HTTPTAG_CONTENT_LOCATION() macro is used to include a tag item with a pointer to a http_content_location_t object in a tag list.
x | pointer to a http_content_location_t header structure, or NULL. |
#define HTTPTAG_CONTENT_LOCATION_STR | ( | s | ) |
Tag list item for string with Content-Location header value.
The HTTPTAG_CONTENT_LOCATION_STR() macro is used to include a tag item with a string containing value of a http_content_location_t header in a tag list.
s | pointer to a string containing http_content_location_t value, or NULL. |
The HTTPTAG_CONTENT_LOCATION_STR string can be converted to a http_content_location_t header structure by giving the string s has second argument to function http_content_location_make().
http_content_location_t * http_content_location_copy | ( | su_home_t * | home, | |
http_content_location_t const * | hdr | |||
) | [inline] |
Copy a http_content_location_t header structure.
The function http_content_location_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.
content_location = http_content_location_copy(home, http->http_content_location);
http_content_location_t * http_content_location_dup | ( | su_home_t * | home, | |
http_content_location_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) http_content_location_t
.
The function http_content_location_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.
content_location = http_content_location_dup(home, http->http_content_location);
http_content_location_t * http_content_location_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Content-Location header from formatting result.
The function http_content_location_format() makes a new Content-Location 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_content_location_t* http_content_location_init | ( | http_content_location_t | x[1] | ) | [inline] |
Initialize a structure http_content_location_t.
An http_content_location_t structure can be initialized with the http_content_location_init() function/macro. For instance,
http_content_location_t http_content_location; http_content_location_init(&http_content_location);
http_content_location_t * http_content_location_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure http_content_location_t.
The function http_content_location_make() makes a new http_content_location_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_content_location | ( | http_header_t const * | header | ) | [inline] |
Test if header object is instance of http_content_location_t.
The function http_is_content_location() returns true (nonzero) if the header class is an instance of Content-Location header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for HTTP Content-Location header.
The header class http_content_location_class defines how a HTTP Content-Location header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_content_location_t header structure.