Collaboration diagram for Unsupported Header:
![]() |
Its syntax is defined in [S20.40] as follows:
Unsupported = "Unsupported" HCOLON [option-tag *(COMMA option-tag)]
Defines | |
#define | sip_unsupported(sip) |
Access a sip_unsupported_t from sip_t. | |
#define | SIP_UNSUPPORTED_INIT() |
Initializer for structure sip_unsupported_t. | |
#define | SIPTAG_UNSUPPORTED(x) |
Tag list item for pointer to a Unsupported header structure. | |
#define | SIPTAG_UNSUPPORTED_REF(x) |
Tag list item for reference to a a Unsupported header pointer. | |
#define | SIPTAG_UNSUPPORTED_STR(s) |
Tag list item for string with Unsupported header value. | |
#define | SIPTAG_UNSUPPORTED_STR_REF(x) |
Tag list item for reference to a a Unsupported header string. | |
Typedefs | |
typedef msg_list_t | sip_unsupported_t |
The structure sip_unsupported_t contains representation of an Unsupported header. | |
Enumerator | |
sip_unsupported_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_unsupported_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Unsupported header. | |
SOFIAPUBFUN int | sip_unsupported_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Unsupported header. | |
sip_unsupported_t * | sip_unsupported_init (sip_unsupported_t x[1]) |
Initialize a structure sip_unsupported_t. | |
int | sip_is_unsupported (sip_header_t const *header) |
Test if header object is instance of sip_unsupported_t. | |
sip_unsupported_t * | sip_unsupported_dup (su_home_t *home, sip_unsupported_t const *hdr)) |
Duplicate (deep copy) sip_unsupported_t . | |
sip_unsupported_t * | sip_unsupported_copy (su_home_t *home, sip_unsupported_t const *hdr)) |
Copy a sip_unsupported_t header structure. | |
sip_unsupported_t * | sip_unsupported_make (su_home_t *home, char const *s)) |
Make a header structure sip_unsupported_t. | |
sip_unsupported_t * | sip_unsupported_format (su_home_t *home, char const *fmt,...))) |
Make a Unsupported header from formatting result. | |
Variables | |
tag_typedef_t | siptag_unsupported |
Tag for Unsupported header object. | |
tag_typedef_t | siptag_unsupported_str |
Tag for string with Unsupported header value. | |
msg_hclass_t | sip_unsupported_class [] |
Header class for SIP Unsupported header. |
#define SIP_UNSUPPORTED_INIT | ( | ) |
Initializer for structure sip_unsupported_t.
A static sip_unsupported_t structure must be initialized. The SIP_UNSUPPORTED_INIT() macro provides initialization value. For instance,
#define SIPTAG_UNSUPPORTED | ( | x | ) |
Tag list item for pointer to a Unsupported header structure.
The SIPTAG_UNSUPPORTED() macro is used to include a tag item with a pointer to a sip_unsupported_t object in a tag list.
x | pointer to a sip_unsupported_t header structure, or NULL. |
#define SIPTAG_UNSUPPORTED_STR | ( | s | ) |
Tag list item for string with Unsupported header value.
The SIPTAG_UNSUPPORTED_STR() macro is used to include a tag item with a string containing value of a sip_unsupported_t header in a tag list.
s | pointer to a string containing sip_unsupported_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_UNSUPPORTED_STR_REF().
struct msg_list_s sip_unsupported_t |
The structure sip_unsupported_t contains representation of an Unsupported header.
The sip_unsupported_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 } sip_unsupported_t;
sip_unsupported_hash |
@
Hash of Unsupported header.
int sip_is_unsupported | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_unsupported_t.
The function sip_is_unsupported() returns true (nonzero) if the header class is an instance of Unsupported header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_unsupported_t * sip_unsupported_copy | ( | su_home_t * | home, | |
sip_unsupported_t const * | hdr | |||
) | [inline] |
Copy a sip_unsupported_t header structure.
The function sip_unsupported_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 |
unsupported = sip_unsupported_copy(home, sip->sip_unsupported);
sip_unsupported_t * sip_unsupported_dup | ( | su_home_t * | home, | |
sip_unsupported_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_unsupported_t
.
The function sip_unsupported_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 |
unsupported = sip_unsupported_dup(home, sip->sip_unsupported);
sip_unsupported_t * sip_unsupported_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Unsupported header from formatting result.
The function sip_unsupported_format() makes a new Unsupported 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_unsupported_t* sip_unsupported_init | ( | sip_unsupported_t | x[1] | ) | [inline] |
Initialize a structure sip_unsupported_t.
An sip_unsupported_t structure can be initialized with the sip_unsupported_init() function/macro. For instance,
sip_unsupported_t sip_unsupported; sip_unsupported_init(&sip_unsupported);
sip_unsupported_t * sip_unsupported_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_unsupported_t.
The function sip_unsupported_make() makes a new sip_unsupported_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 |
Header class for SIP Unsupported header.
The header class sip_unsupported_class defines how a SIP Unsupported header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_unsupported_t header structure.