Its syntax is defined in RFC 3261 as follows:
Proxy-Require = "Proxy-Require" HCOLON option-tag *(COMMA option-tag)
The parsed Proxy-Require header is stored in sip_proxy_require_t structure.
#define SIP_PROXY_REQUIRE_INIT | ( | ) |
Initializer for structure sip_proxy_require_t.
A static sip_proxy_require_t structure for Proxy-Require header must be initialized with the SIP_PROXY_REQUIRE_INIT() macro. For instance,
#define SIPTAG_PROXY_REQUIRE | ( | x | ) |
Tag list item for pointer to a Proxy-Require header structure sip_proxy_require_t.
The SIPTAG_PROXY_REQUIRE() macro is used to include a tag item with a pointer to a sip_proxy_require_t structure in a tag list.
x | pointer to a sip_proxy_require_t 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 Proxy-Require header 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; // Dummy link msg_param_t *k_items; // List of items } sip_proxy_require_t;
int sip_is_proxy_require | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_proxy_require_t.
Check if the header class is an instance of Proxy-Require header object and return true (nonzero), otherwise return false (zero).
header | pointer to the header structure to be tested |
1 | (true) if the header is an instance of header proxy_require | |
0 | (false) otherwise |
sip_proxy_require_t * sip_proxy_require_copy | ( | su_home_t * | home, | |
sip_proxy_require_t const * | hdr | |||
) | [inline] |
Copy a list of Proxy-Require header header structures sip_proxy_require_t.
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 list of 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 a list of Proxy-Require header header structures sip_proxy_require_t.
Duplicate 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.
Make a new sip_proxy_require_t 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 parses the formatting result to the structure sip_proxy_require_t.
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 for Proxy-Require header 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 Proxy-Require 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 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.