Collaboration diagram for Supported Header:
![]() |
Its syntax is defined in [S10.41] as follows:
Supported = ( "Supported" / "k" ) HCOLON [option-tag *(COMMA option-tag)]
Defines | |
#define | sip_supported(sip) |
Access a sip_supported_t from sip_t. | |
#define | SIP_SUPPORTED_INIT() |
Initializer for structure sip_supported_t. | |
#define | SIPTAG_SUPPORTED(x) |
Tag list item for pointer to a Supported header structure. | |
#define | SIPTAG_SUPPORTED_REF(x) |
Tag list item for reference to a a Supported header pointer. | |
#define | SIPTAG_SUPPORTED_STR(s) |
Tag list item for string with Supported header value. | |
#define | SIPTAG_SUPPORTED_STR_REF(x) |
Tag list item for reference to a a Supported header string. | |
Typedefs | |
typedef msg_list_t | sip_supported_t |
The structure sip_supported_t contains representation of an Supported header. | |
Enumerator | |
sip_supported_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_supported_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Supported header. | |
SOFIAPUBFUN int | sip_supported_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Supported header. | |
sip_supported_t * | sip_supported_init (sip_supported_t x[1]) |
Initialize a structure sip_supported_t. | |
int | sip_is_supported (sip_header_t const *header) |
Test if header object is instance of sip_supported_t. | |
sip_supported_t * | sip_supported_dup (su_home_t *home, sip_supported_t const *hdr)) |
Duplicate (deep copy) sip_supported_t . | |
sip_supported_t * | sip_supported_copy (su_home_t *home, sip_supported_t const *hdr)) |
Copy a sip_supported_t header structure. | |
sip_supported_t * | sip_supported_make (su_home_t *home, char const *s)) |
Make a header structure sip_supported_t. | |
sip_supported_t * | sip_supported_format (su_home_t *home, char const *fmt,...))) |
Make a Supported header from formatting result. | |
Variables | |
tag_typedef_t | siptag_supported |
Tag for Supported header object. | |
tag_typedef_t | siptag_supported_str |
Tag for string with Supported header value. | |
msg_hclass_t | sip_supported_class [] |
Header class for SIP Supported header. |
#define SIP_SUPPORTED_INIT | ( | ) |
Initializer for structure sip_supported_t.
A static sip_supported_t structure must be initialized. The SIP_SUPPORTED_INIT() macro provides initialization value. For instance,
#define SIPTAG_SUPPORTED | ( | x | ) |
Tag list item for pointer to a Supported header structure.
The SIPTAG_SUPPORTED() macro is used to include a tag item with a pointer to a sip_supported_t object in a tag list.
x | pointer to a sip_supported_t header structure, or NULL. |
#define SIPTAG_SUPPORTED_STR | ( | s | ) |
Tag list item for string with Supported header value.
The SIPTAG_SUPPORTED_STR() macro is used to include a tag item with a string containing value of a sip_supported_t header in a tag list.
s | pointer to a string containing sip_supported_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SUPPORTED_STR_REF().
struct msg_list_s sip_supported_t |
The structure sip_supported_t contains representation of an Supported header.
The sip_supported_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_supported_t;
sip_supported_hash |
@
Hash of Supported header.
int sip_is_supported | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_supported_t.
The function sip_is_supported() returns true (nonzero) if the header class is an instance of Supported header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_supported_t * sip_supported_copy | ( | su_home_t * | home, | |
sip_supported_t const * | hdr | |||
) | [inline] |
Copy a sip_supported_t header structure.
The function sip_supported_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 |
supported = sip_supported_copy(home, sip->sip_supported);
sip_supported_t * sip_supported_dup | ( | su_home_t * | home, | |
sip_supported_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_supported_t
.
The function sip_supported_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 |
supported = sip_supported_dup(home, sip->sip_supported);
sip_supported_t * sip_supported_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Supported header from formatting result.
The function sip_supported_format() makes a new Supported 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_supported_t* sip_supported_init | ( | sip_supported_t | x[1] | ) | [inline] |
Initialize a structure sip_supported_t.
An sip_supported_t structure can be initialized with the sip_supported_init() function/macro. For instance,
sip_supported_t sip_supported; sip_supported_init(&sip_supported);
sip_supported_t * sip_supported_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_supported_t.
The function sip_supported_make() makes a new sip_supported_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 Supported header.
The header class sip_supported_class defines how a SIP Supported header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_supported_t header structure.