Collaboration diagram for Proxy-Require Header:
![]() |
Its syntax is defined in [S10.33] as follows:
Proxy-Require = "Proxy-Require" HCOLON option-tag *(COMMA option-tag)
Defines | |
#define | sip_proxy_require(sip) |
Access a sip_proxy_require_t from sip_t. | |
#define | SIP_PROXY_REQUIRE_INIT() |
Initializer for structure sip_proxy_require_t. | |
#define | SIPTAG_PROXY_REQUIRE(x) |
Tag list item for pointer to a Proxy-Require header structure. | |
#define | SIPTAG_PROXY_REQUIRE_REF(x) |
Tag list item for reference to a a Proxy-Require header pointer. | |
#define | SIPTAG_PROXY_REQUIRE_STR(s) |
Tag list item for string with Proxy-Require header value. | |
#define | SIPTAG_PROXY_REQUIRE_STR_REF(x) |
Tag list item for reference to a a Proxy-Require header string. | |
Typedefs | |
typedef msg_list_t | sip_proxy_require_t |
The structure sip_proxy_require_t contains representation of an Proxy-Require header. | |
Enumerator | |
sip_proxy_require_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_proxy_require_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Proxy-Require header. | |
SOFIAPUBFUN int | sip_proxy_require_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Proxy-Require header. | |
sip_proxy_require_t * | sip_proxy_require_init (sip_proxy_require_t x[1]) |
Initialize a structure sip_proxy_require_t. | |
int | sip_is_proxy_require (sip_header_t const *header) |
Test if header object is instance of sip_proxy_require_t. | |
sip_proxy_require_t * | sip_proxy_require_dup (su_home_t *home, sip_proxy_require_t const *hdr)) |
Duplicate (deep copy) sip_proxy_require_t . | |
sip_proxy_require_t * | sip_proxy_require_copy (su_home_t *home, sip_proxy_require_t const *hdr)) |
Copy a sip_proxy_require_t header structure. | |
sip_proxy_require_t * | sip_proxy_require_make (su_home_t *home, char const *s)) |
Make a header structure sip_proxy_require_t. | |
sip_proxy_require_t * | sip_proxy_require_format (su_home_t *home, char const *fmt,...))) |
Make a Proxy-Require header from formatting result. | |
Variables | |
tag_typedef_t | siptag_proxy_require |
Tag for Proxy-Require header object. | |
tag_typedef_t | siptag_proxy_require_str |
Tag for string with Proxy-Require header value. | |
msg_hclass_t | sip_proxy_require_class [] |
Header class for SIP Proxy-Require header. |
#define SIP_PROXY_REQUIRE_INIT | ( | ) |
Initializer for structure sip_proxy_require_t.
A static sip_proxy_require_t structure must be initialized. The SIP_PROXY_REQUIRE_INIT() macro provides initialization value. For instance,
#define SIPTAG_PROXY_REQUIRE | ( | x | ) |
Tag list item for pointer to a Proxy-Require header structure.
The SIPTAG_PROXY_REQUIRE() macro is used to include a tag item with a pointer to a sip_proxy_require_t object in a tag list.
x | pointer to a sip_proxy_require_t header structure, or NULL. |
#define SIPTAG_PROXY_REQUIRE_STR | ( | s | ) |
Tag list item for string with Proxy-Require header value.
The SIPTAG_PROXY_REQUIRE_STR() macro is used to include a tag item with a string containing value of a sip_proxy_require_t header in a tag list.
s | pointer to a string containing sip_proxy_require_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_PROXY_REQUIRE_STR_REF().
struct msg_list_s sip_proxy_require_t |
The structure sip_proxy_require_t contains representation of an Proxy-Require header.
The sip_proxy_require_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_proxy_require_t;
sip_proxy_require_hash |
@
Hash of Proxy-Require header.
int sip_is_proxy_require | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_proxy_require_t.
The function sip_is_proxy_require() returns true (nonzero) if the header class is an instance of Proxy-Require header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_proxy_require_t * sip_proxy_require_copy | ( | su_home_t * | home, | |
sip_proxy_require_t const * | hdr | |||
) | [inline] |
Copy a sip_proxy_require_t header structure.
The function sip_proxy_require_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 |
proxy_require = sip_proxy_require_copy(home, sip->sip_proxy_require);
sip_proxy_require_t * sip_proxy_require_dup | ( | su_home_t * | home, | |
sip_proxy_require_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_proxy_require_t
.
The function sip_proxy_require_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 |
proxy_require = sip_proxy_require_dup(home, sip->sip_proxy_require);
sip_proxy_require_t * sip_proxy_require_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Proxy-Require header from formatting result.
The function sip_proxy_require_format() makes a new Proxy-Require 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_proxy_require_t* sip_proxy_require_init | ( | sip_proxy_require_t | x[1] | ) | [inline] |
Initialize a structure sip_proxy_require_t.
An sip_proxy_require_t structure can be initialized with the sip_proxy_require_init() function/macro. For instance,
sip_proxy_require_t sip_proxy_require; sip_proxy_require_init(&sip_proxy_require);
sip_proxy_require_t * sip_proxy_require_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_proxy_require_t.
The function sip_proxy_require_make() makes a new sip_proxy_require_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 Proxy-Require header.
The header class sip_proxy_require_class defines how a SIP Proxy-Require header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_proxy_require_t header structure.