Collaboration diagram for Accept-Language Header:
![]() |
Its syntax is defined in [H14.4, S10.8] as follows:
Accept-Language = "Accept-Language" HCOLON [ language *(COMMA language) ] language = language-range *(SEMI accept-param) language-range = ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) / "*" )
Defines | |
#define | sip_accept_language(sip) |
Access a sip_accept_language_t from sip_t. | |
#define | SIP_ACCEPT_LANGUAGE_INIT() |
Initializer for structure sip_accept_language_t. | |
#define | SIPTAG_ACCEPT_LANGUAGE(x) |
Tag list item for pointer to a Accept-Language header structure. | |
#define | SIPTAG_ACCEPT_LANGUAGE_REF(x) |
Tag list item for reference to a a Accept-Language header pointer. | |
#define | SIPTAG_ACCEPT_LANGUAGE_STR(s) |
Tag list item for string with Accept-Language header value. | |
#define | SIPTAG_ACCEPT_LANGUAGE_STR_REF(x) |
Tag list item for reference to a a Accept-Language header string. | |
Typedefs | |
typedef msg_accept_any_t | sip_accept_language_t |
The structure sip_accept_language_t contains representation of SIP Accept-Language header. | |
Enumerator | |
sip_accept_language_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_accept_language_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Accept-Language header. | |
SOFIAPUBFUN int | sip_accept_language_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Accept-Language header. | |
sip_accept_language_t * | sip_accept_language_init (sip_accept_language_t x[1]) |
Initialize a structure sip_accept_language_t. | |
int | sip_is_accept_language (sip_header_t const *header) |
Test if header object is instance of sip_accept_language_t. | |
sip_accept_language_t * | sip_accept_language_dup (su_home_t *home, sip_accept_language_t const *hdr)) |
Duplicate (deep copy) sip_accept_language_t . | |
sip_accept_language_t * | sip_accept_language_copy (su_home_t *home, sip_accept_language_t const *hdr)) |
Copy a sip_accept_language_t header structure. | |
sip_accept_language_t * | sip_accept_language_make (su_home_t *home, char const *s)) |
Make a header structure sip_accept_language_t. | |
sip_accept_language_t * | sip_accept_language_format (su_home_t *home, char const *fmt,...))) |
Make a Accept-Language header from formatting result. | |
Variables | |
tag_typedef_t | siptag_accept_language |
Tag for Accept-Language header object. | |
tag_typedef_t | siptag_accept_language_str |
Tag for string with Accept-Language header value. | |
msg_hclass_t | sip_accept_language_class [] |
Header class for SIP Accept-Language header. |
#define SIP_ACCEPT_LANGUAGE_INIT | ( | ) |
Initializer for structure sip_accept_language_t.
A static sip_accept_language_t structure must be initialized. The SIP_ACCEPT_LANGUAGE_INIT() macro provides initialization value. For instance,
#define SIPTAG_ACCEPT_LANGUAGE | ( | x | ) |
Tag list item for pointer to a Accept-Language header structure.
The SIPTAG_ACCEPT_LANGUAGE() macro is used to include a tag item with a pointer to a sip_accept_language_t object in a tag list.
x | pointer to a sip_accept_language_t header structure, or NULL. |
#define SIPTAG_ACCEPT_LANGUAGE_STR | ( | s | ) |
Tag list item for string with Accept-Language header value.
The SIPTAG_ACCEPT_LANGUAGE_STR() macro is used to include a tag item with a string containing value of a sip_accept_language_t header in a tag list.
s | pointer to a string containing sip_accept_language_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_ACCEPT_LANGUAGE_STR_REF().
typedef struct msg_accept_any_s sip_accept_language_t |
The structure sip_accept_language_t contains representation of SIP Accept-Language header.
The sip_accept_language_t is defined as follows:
typedef struct { msg_common_t aa_common[1]; // Common fragment info sip_accept_language_t *aa_next; // Pointer to next Accept-Language header char const *aa_value; // Language-range msg_param_t const *aa_params; // List of accept-parameters char const *aa_q; // Value of q parameter } sip_accept_language_t;
sip_accept_language_hash |
@
Hash of Accept-Language header.
sip_accept_language_t * sip_accept_language_copy | ( | su_home_t * | home, | |
sip_accept_language_t const * | hdr | |||
) | [inline] |
Copy a sip_accept_language_t header structure.
The function sip_accept_language_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_language = sip_accept_language_copy(home, sip->sip_accept_language);
sip_accept_language_t * sip_accept_language_dup | ( | su_home_t * | home, | |
sip_accept_language_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_accept_language_t
.
The function sip_accept_language_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_language = sip_accept_language_dup(home, sip->sip_accept_language);
sip_accept_language_t * sip_accept_language_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Accept-Language header from formatting result.
The function sip_accept_language_format() makes a new Accept-Language 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_language_t* sip_accept_language_init | ( | sip_accept_language_t | x[1] | ) | [inline] |
Initialize a structure sip_accept_language_t.
An sip_accept_language_t structure can be initialized with the sip_accept_language_init() function/macro. For instance,
sip_accept_language_t sip_accept_language; sip_accept_language_init(&sip_accept_language);
sip_accept_language_t * sip_accept_language_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_accept_language_t.
The function sip_accept_language_make() makes a new sip_accept_language_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_language | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_accept_language_t.
The function sip_is_accept_language() returns true (nonzero) if the header class is an instance of Accept-Language header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Accept-Language header.
The header class sip_accept_language_class defines how a SIP Accept-Language header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_accept_language_t header structure.