Collaboration diagram for Priority Header:
![]() |
Its syntax is defined in [S10.30] as follows:
Priority = "Priority" HCOLON priority-value priority-value = "emergency" / "urgent" / "normal" / "non-urgent" / other-priority other-priority = token
Defines | |
#define | sip_priority(sip) |
Access a sip_priority_t from sip_t. | |
#define | SIP_PRIORITY_INIT() |
Initializer for structure sip_priority_t. | |
#define | SIPTAG_PRIORITY(x) |
Tag list item for pointer to a Priority header structure. | |
#define | SIPTAG_PRIORITY_REF(x) |
Tag list item for reference to a a Priority header pointer. | |
#define | SIPTAG_PRIORITY_STR(s) |
Tag list item for string with Priority header value. | |
#define | SIPTAG_PRIORITY_STR_REF(x) |
Tag list item for reference to a a Priority header string. | |
Enumerator | |
sip_priority_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_priority_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Priority header. | |
SOFIAPUBFUN int | sip_priority_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Priority header. | |
sip_priority_t * | sip_priority_init (sip_priority_t x[1]) |
Initialize a structure sip_priority_t. | |
int | sip_is_priority (sip_header_t const *header) |
Test if header object is instance of sip_priority_t. | |
sip_priority_t * | sip_priority_dup (su_home_t *home, sip_priority_t const *hdr)) |
Duplicate (deep copy) sip_priority_t . | |
sip_priority_t * | sip_priority_copy (su_home_t *home, sip_priority_t const *hdr)) |
Copy a sip_priority_t header structure. | |
sip_priority_t * | sip_priority_make (su_home_t *home, char const *s)) |
Make a header structure sip_priority_t. | |
sip_priority_t * | sip_priority_format (su_home_t *home, char const *fmt,...))) |
Make a Priority header from formatting result. | |
Variables | |
tag_typedef_t | siptag_priority |
Tag for Priority header object. | |
tag_typedef_t | siptag_priority_str |
Tag for string with Priority header value. | |
msg_hclass_t | sip_priority_class [] |
Header class for SIP Priority header. |
#define SIP_PRIORITY_INIT | ( | ) |
Initializer for structure sip_priority_t.
A static sip_priority_t structure must be initialized. The SIP_PRIORITY_INIT() macro provides initialization value. For instance,
#define SIPTAG_PRIORITY | ( | x | ) |
Tag list item for pointer to a Priority header structure.
The SIPTAG_PRIORITY() macro is used to include a tag item with a pointer to a sip_priority_t object in a tag list.
x | pointer to a sip_priority_t header structure, or NULL. |
#define SIPTAG_PRIORITY_STR | ( | s | ) |
Tag list item for string with Priority header value.
The SIPTAG_PRIORITY_STR() macro is used to include a tag item with a string containing value of a sip_priority_t header in a tag list.
s | pointer to a string containing sip_priority_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_PRIORITY_STR_REF().
sip_priority_hash |
@
Hash of Priority header.
int sip_is_priority | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_priority_t.
The function sip_is_priority() returns true (nonzero) if the header class is an instance of Priority header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_priority_t * sip_priority_copy | ( | su_home_t * | home, | |
sip_priority_t const * | hdr | |||
) | [inline] |
Copy a sip_priority_t header structure.
The function sip_priority_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 |
priority = sip_priority_copy(home, sip->sip_priority);
sip_priority_t * sip_priority_dup | ( | su_home_t * | home, | |
sip_priority_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_priority_t
.
The function sip_priority_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 |
priority = sip_priority_dup(home, sip->sip_priority);
sip_priority_t * sip_priority_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Priority header from formatting result.
The function sip_priority_format() makes a new Priority 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_priority_t* sip_priority_init | ( | sip_priority_t | x[1] | ) | [inline] |
Initialize a structure sip_priority_t.
An sip_priority_t structure can be initialized with the sip_priority_init() function/macro. For instance,
sip_priority_t * sip_priority_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_priority_t.
The function sip_priority_make() makes a new sip_priority_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 Priority header.
The header class sip_priority_class defines how a SIP Priority header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_priority_t header structure.