Collaboration diagram for Allow-Event Header:
![]() |
Its syntax is defined in RFC 3265 as follows:
Allow-Events = ( "Allow-Events" | "u" ) ":" 1#event-type
Defines | |
#define | sip_allow_events(sip) |
Access a sip_allow_events_t from sip_t. | |
#define | SIP_ALLOW_EVENTS_INIT() |
Initializer for structure sip_allow_events_t. | |
#define | SIPTAG_ALLOW_EVENTS(x) |
Tag list item for pointer to a Allow-Events header structure. | |
#define | SIPTAG_ALLOW_EVENTS_REF(x) |
Tag list item for reference to a a Allow-Events header pointer. | |
#define | SIPTAG_ALLOW_EVENTS_STR(s) |
Tag list item for string with Allow-Events header value. | |
#define | SIPTAG_ALLOW_EVENTS_STR_REF(x) |
Tag list item for reference to a a Allow-Events header string. | |
Typedefs | |
typedef msg_list_t | sip_allow_events_t |
The structure sip_allow_events_t contains representation of an Allow-Events header. | |
Enumerator | |
sip_allow_events_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_allow_events_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Allow-Events header. | |
SOFIAPUBFUN int | sip_allow_events_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Allow-Events header. | |
sip_allow_events_t * | sip_allow_events_init (sip_allow_events_t x[1]) |
Initialize a structure sip_allow_events_t. | |
int | sip_is_allow_events (sip_header_t const *header) |
Test if header object is instance of sip_allow_events_t. | |
sip_allow_events_t * | sip_allow_events_dup (su_home_t *home, sip_allow_events_t const *hdr)) |
Duplicate (deep copy) sip_allow_events_t . | |
sip_allow_events_t * | sip_allow_events_copy (su_home_t *home, sip_allow_events_t const *hdr)) |
Copy a sip_allow_events_t header structure. | |
sip_allow_events_t * | sip_allow_events_make (su_home_t *home, char const *s)) |
Make a header structure sip_allow_events_t. | |
sip_allow_events_t * | sip_allow_events_format (su_home_t *home, char const *fmt,...))) |
Make a Allow-Events header from formatting result. | |
Variables | |
tag_typedef_t | siptag_allow_events |
Tag for Allow-Events header object. | |
tag_typedef_t | siptag_allow_events_str |
Tag for string with Allow-Events header value. | |
msg_hclass_t | sip_allow_events_class [] |
Header class for SIP Allow-Events header. |
#define SIP_ALLOW_EVENTS_INIT | ( | ) |
Initializer for structure sip_allow_events_t.
A static sip_allow_events_t structure must be initialized. The SIP_ALLOW_EVENTS_INIT() macro provides initialization value. For instance,
#define SIPTAG_ALLOW_EVENTS | ( | x | ) |
Tag list item for pointer to a Allow-Events header structure.
The SIPTAG_ALLOW_EVENTS() macro is used to include a tag item with a pointer to a sip_allow_events_t object in a tag list.
x | pointer to a sip_allow_events_t header structure, or NULL. |
#define SIPTAG_ALLOW_EVENTS_STR | ( | s | ) |
Tag list item for string with Allow-Events header value.
The SIPTAG_ALLOW_EVENTS_STR() macro is used to include a tag item with a string containing value of a sip_allow_events_t header in a tag list.
s | pointer to a string containing sip_allow_events_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_ALLOW_EVENTS_STR_REF().
struct msg_list_s sip_allow_events_t |
The structure sip_allow_events_t contains representation of an Allow-Events header.
The sip_allow_events_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_allow_events_t;
sip_allow_events_hash |
@
Hash of Allow-Events header.
sip_allow_events_t * sip_allow_events_copy | ( | su_home_t * | home, | |
sip_allow_events_t const * | hdr | |||
) | [inline] |
Copy a sip_allow_events_t header structure.
The function sip_allow_events_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 |
allow_events = sip_allow_events_copy(home, sip->sip_allow_events);
sip_allow_events_t * sip_allow_events_dup | ( | su_home_t * | home, | |
sip_allow_events_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_allow_events_t
.
The function sip_allow_events_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 |
allow_events = sip_allow_events_dup(home, sip->sip_allow_events);
sip_allow_events_t * sip_allow_events_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Allow-Events header from formatting result.
The function sip_allow_events_format() makes a new Allow-Events 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_allow_events_t* sip_allow_events_init | ( | sip_allow_events_t | x[1] | ) | [inline] |
Initialize a structure sip_allow_events_t.
An sip_allow_events_t structure can be initialized with the sip_allow_events_init() function/macro. For instance,
sip_allow_events_t sip_allow_events; sip_allow_events_init(&sip_allow_events);
sip_allow_events_t * sip_allow_events_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_allow_events_t.
The function sip_allow_events_make() makes a new sip_allow_events_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_allow_events | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_allow_events_t.
The function sip_is_allow_events() returns true (nonzero) if the header class is an instance of Allow-Events header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Allow-Events header.
The header class sip_allow_events_class defines how a SIP Allow-Events header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_allow_events_t header structure.