The Content-Encoding header indicates what additional content codings have been applied to the entity-body. More...
Defines | |
#define | MSG_CONTENT_ENCODING_INIT() |
Initializer for an msg_content_encoding_t structure. | |
Typedefs | |
typedef msg_list_t | msg_content_encoding_t |
The structure msg_content_encoding_t contains representation of an Content-Encoding header. | |
Enumerations | |
enum | { msg_content_encoding_hash } |
Functions | |
msg_content_encoding_t * | msg_content_encoding_init (msg_content_encoding_t x[1]) |
Initialize an msg_content_encoding_t structure. | |
int | msg_is_content_encoding (msg_header_t const *header) |
Test if header object is an instance of msg_content_encoding_t. | |
msg_content_encoding_t * | msg_content_encoding_dup (su_home_t *home, msg_content_encoding_t const *header) |
Duplicate (deep copy) msg_content_encoding_t. | |
msg_content_encoding_t * | msg_content_encoding_copy (su_home_t *home, msg_content_encoding_t const *header) |
Copy an msg_content_encoding_t header structure. | |
msg_content_encoding_t * | msg_content_encoding_make (su_home_t *home, char const *s) |
Make a header structure msg_content_encoding_t. | |
msg_content_encoding_t * | msg_content_encoding_format (su_home_t *home, char const *fmt,...))) |
Make a Content-Encoding header from formatting result. | |
Variables | |
msg_parse_f | msg_content_encoding_d |
Parse a Content-Encoding header. | |
msg_print_f | msg_content_encoding_e |
Print a Content-Encoding header. | |
msg_hclass_t | msg_content_encoding_class [] |
Header class for Content-Encoding header. |
The Content-Encoding header indicates what additional content codings have been applied to the entity-body.
Its syntax is defined in [H14.11] and [S20.12] as follows:
Content-Encoding = ( "Content-Encoding" / "e" ) ":" 1#content-coding content-coding = token
#define MSG_CONTENT_ENCODING_INIT | ( | ) |
Initializer for an msg_content_encoding_t structure.
A static msg_content_encoding_t structure must be initialized with the MSG_CONTENT_ENCODING_INIT() macro. For instance,
msg_content_encoding_t msg_content_encoding = MSG_CONTENT_ENCODING_INIT;
struct msg_list_s msg_content_encoding_t |
The structure msg_content_encoding_t contains representation of an Content-Encoding header.
The msg_content_encoding_t is defined as follows:
typedef struct msg_list_s { msg_common_t k_common[1]; // Common fragment info msg_list_t *k_next; // Link to next header msg_param_t *k_items; // List of items } msg_content_encoding_t;
msg_content_encoding_t * msg_content_encoding_copy | ( | su_home_t * | home, | |
msg_content_encoding_t const * | header | |||
) | [inline] |
Copy an msg_content_encoding_t header structure.
The function msg_content_encoding_copy() copies a header structure header. If the header structure header contains a reference (header->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 header.
home | memory home used to allocate new structure | |
header | 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_encoding = msg_content_encoding_copy(home, msg->msg_content_encoding);
msg_content_encoding_t * msg_content_encoding_dup | ( | su_home_t * | home, | |
msg_content_encoding_t const * | header | |||
) | [inline] |
Duplicate (deep copy) msg_content_encoding_t.
The function msg_content_encoding_dup() duplicates a header structure header. If the header structure header contains a reference (header->x_next
) to a list of headers, all the headers in the list are duplicated, too.
home | memory home used to allocate new structure | |
header | 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_encoding = msg_content_encoding_dup(home, msg->msg_content_encoding);
msg_content_encoding_t * msg_content_encoding_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Content-Encoding header from formatting result.
The function msg_content_encoding_format() makes a new Content-Encoding header object using snprintf-formatted 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 |
msg_content_encoding_t* msg_content_encoding_init | ( | msg_content_encoding_t | x[1] | ) | [inline] |
Initialize an msg_content_encoding_t structure.
An msg_content_encoding_t structure can be initialized with the msg_content_encoding_init() function/macro. For instance,
msg_content_encoding_t msg_content_encoding; msg_content_encoding_init(&msg_content_encoding);
x | pointer to msg_content_encoding_t structure |
msg_content_encoding_t* msg_content_encoding_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure msg_content_encoding_t.
The function msg_content_encoding_make() makes a new msg_content_encoding_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 msg_is_content_encoding | ( | msg_header_t const * | header | ) | [inline] |
Test if header object is an instance of msg_content_encoding_t.
The function msg_is_content_encoding() returns true (nonzero) if the header class is an instance of Content-Encoding header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for Content-Encoding header.
The header class msg_content_encoding_class defines how a Content-Encoding header header is parsed and printed. It also contains methods used by message parser and other functions to manipulate the msg_content_encoding_t header structure.