Collaboration diagram for Accept-Encoding Header:
![]() |
Its syntax is defined in [H14.3, S10.7] as follows:
Accept-Encoding = "Accept-Encoding" HCOLON
[ encoding *(COMMA encoding) ]
encoding = codings *(SEMI accept-param)
codings = content-coding / "*"
content-coding = token
Defines | |
#define | sip_accept_encoding(sip) |
Access a sip_accept_encoding_t from sip_t. | |
#define | SIP_ACCEPT_ENCODING_INIT() |
Initializer for structure sip_accept_encoding_t. | |
#define | SIPTAG_ACCEPT_ENCODING(x) |
Tag list item for pointer to a Accept-Encoding header structure. | |
#define | SIPTAG_ACCEPT_ENCODING_REF(x) |
Tag list item for reference to a a Accept-Encoding header pointer. | |
#define | SIPTAG_ACCEPT_ENCODING_STR(s) |
Tag list item for string with Accept-Encoding header value. | |
#define | SIPTAG_ACCEPT_ENCODING_STR_REF(x) |
Tag list item for reference to a a Accept-Encoding header string. | |
Typedefs | |
typedef msg_accept_any_t | sip_accept_encoding_t |
The structure sip_accept_encoding_t contains representation of SIP Accept-Encoding header. | |
Enumerator | |
sip_accept_encoding_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_accept_encoding_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Accept-Encoding header. | |
SOFIAPUBFUN int | sip_accept_encoding_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Accept-Encoding header. | |
sip_accept_encoding_t * | sip_accept_encoding_init (sip_accept_encoding_t x[1]) |
Initialize a structure sip_accept_encoding_t. | |
int | sip_is_accept_encoding (sip_header_t const *header) |
Test if header object is instance of sip_accept_encoding_t. | |
sip_accept_encoding_t * | sip_accept_encoding_dup (su_home_t *home, sip_accept_encoding_t const *hdr)) |
Duplicate (deep copy) sip_accept_encoding_t . | |
sip_accept_encoding_t * | sip_accept_encoding_copy (su_home_t *home, sip_accept_encoding_t const *hdr)) |
Copy a sip_accept_encoding_t header structure. | |
sip_accept_encoding_t * | sip_accept_encoding_make (su_home_t *home, char const *s)) |
Make a header structure sip_accept_encoding_t. | |
sip_accept_encoding_t * | sip_accept_encoding_format (su_home_t *home, char const *fmt,...))) |
Make a Accept-Encoding header from formatting result. | |
Variables | |
tag_typedef_t | siptag_accept_encoding |
Tag for Accept-Encoding header object. | |
tag_typedef_t | siptag_accept_encoding_str |
Tag for string with Accept-Encoding header value. | |
msg_hclass_t | sip_accept_encoding_class [] |
Header class for SIP Accept-Encoding header. |
#define SIP_ACCEPT_ENCODING_INIT | ( | ) |
Initializer for structure sip_accept_encoding_t.
A static sip_accept_encoding_t structure must be initialized. The SIP_ACCEPT_ENCODING_INIT() macro provides initialization value. For instance,
#define SIPTAG_ACCEPT_ENCODING | ( | x | ) |
Tag list item for pointer to a Accept-Encoding header structure.
The SIPTAG_ACCEPT_ENCODING() macro is used to include a tag item with a pointer to a sip_accept_encoding_t object in a tag list.
x | pointer to a sip_accept_encoding_t header structure, or NULL. |
#define SIPTAG_ACCEPT_ENCODING_STR | ( | s | ) |
Tag list item for string with Accept-Encoding header value.
The SIPTAG_ACCEPT_ENCODING_STR() macro is used to include a tag item with a string containing value of a sip_accept_encoding_t header in a tag list.
s | pointer to a string containing sip_accept_encoding_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_ACCEPT_ENCODING_STR_REF().
typedef struct msg_accept_any_s sip_accept_encoding_t |
The structure sip_accept_encoding_t contains representation of SIP Accept-Encoding header.
The sip_accept_encoding_t is defined as follows:
typedef struct { msg_common_t aa_common[1]; // Common fragment info sip_accept_encoding_t *aa_next; // Pointer to next Accept-Encoding header char const *aa_value; // Encoding token msg_param_t const *aa_params; // List of parameters char const *aa_q; // Value of q parameter } sip_accept_encoding_t;
sip_accept_encoding_hash |
@
Hash of Accept-Encoding header.
sip_accept_encoding_t * sip_accept_encoding_copy | ( | su_home_t * | home, | |
sip_accept_encoding_t const * | hdr | |||
) | [inline] |
Copy a sip_accept_encoding_t header structure.
The function sip_accept_encoding_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 copied |
accept_encoding = sip_accept_encoding_copy(home, sip->sip_accept_encoding);
sip_accept_encoding_t * sip_accept_encoding_dup | ( | su_home_t * | home, | |
sip_accept_encoding_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_accept_encoding_t
.
The function sip_accept_encoding_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 |
accept_encoding = sip_accept_encoding_dup(home, sip->sip_accept_encoding);
sip_accept_encoding_t * sip_accept_encoding_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Accept-Encoding header from formatting result.
The function sip_accept_encoding_format() makes a new Accept-Encoding 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 |
sip_accept_encoding_t* sip_accept_encoding_init | ( | sip_accept_encoding_t | x[1] | ) | [inline] |
Initialize a structure sip_accept_encoding_t.
An sip_accept_encoding_t structure can be initialized with the sip_accept_encoding_init() function/macro. For instance,
sip_accept_encoding_t sip_accept_encoding; sip_accept_encoding_init(&sip_accept_encoding);
sip_accept_encoding_t * sip_accept_encoding_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_accept_encoding_t.
The function sip_accept_encoding_make() makes a new sip_accept_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 sip_is_accept_encoding | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_accept_encoding_t.
The function sip_is_accept_encoding() returns true (nonzero) if the header class is an instance of Accept-Encoding header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Accept-Encoding header.
The header class sip_accept_encoding_class defines how a SIP Accept-Encoding header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_accept_encoding_t header structure.