sip 1.12.11devel
|
Data Structures | |
struct | sip_privacy_s |
Structure for Privacy header. More... | |
Macros | |
#define | sip_privacy(sip) |
Access a SIP Privacy header structure sip_privacy_t from sip_t. | |
#define | SIP_PRIVACY_INIT() |
Initializer for structure sip_privacy_t. | |
#define | SIPTAG_PRIVACY(x) |
Tag list item for pointer to a Privacy header structure sip_privacy_t. | |
#define | SIPTAG_PRIVACY_REF(x) |
Tag list item for reference to a Privacy header pointer. | |
#define | SIPTAG_PRIVACY_STR(s) |
Tag list item for string with Privacy header value. | |
#define | SIPTAG_PRIVACY_STR_REF(x) |
Tag list item for reference to a Privacy header string. | |
Functions | |
issize_t | sip_privacy_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
Parse a SIP Privacy header. | |
issize_t | sip_privacy_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
Print a SIP Privacy header. | |
sip_privacy_t * | sip_privacy_init (sip_privacy_t x[1]) |
Initialize a structure sip_privacy_t. | |
int | sip_is_privacy (sip_header_t const *header) |
Test if header object is instance of sip_privacy_t. | |
sip_privacy_t * | sip_privacy_dup (su_home_t *home, sip_privacy_t const *hdr)) |
Duplicate a list of Privacy header header structures sip_privacy_t. | |
sip_privacy_t * | sip_privacy_copy (su_home_t *home, sip_privacy_t const *hdr)) |
Copy a list of Privacy header header structures sip_privacy_t. | |
sip_privacy_t * | sip_privacy_make (su_home_t *home, char const *s)) |
Make a Privacy header structure sip_privacy_t. | |
sip_privacy_t * | sip_privacy_format (su_home_t *home, char const *fmt,...))) |
Make a Privacy header from formatting result. | |
Variables | |
msg_hclass_t | sip_privacy_class [] |
Header class for Privacy header. | |
tag_typedef_t | siptag_privacy |
Tag for Privacy header object. | |
tag_typedef_t | siptag_privacy_str |
Tag for string with Privacy header value. | |
#define SIP_PRIVACY_INIT | ( | ) |
Initializer for structure sip_privacy_t.
A static sip_privacy_t structure for Privacy header must be initialized with the SIP_PRIVACY_INIT() macro. For instance,
#define SIPTAG_PRIVACY | ( | x | ) |
Tag list item for pointer to a Privacy header structure sip_privacy_t.
The SIPTAG_PRIVACY() macro is used to include a tag item with a pointer to a sip_privacy_t structure in a tag list.
x | pointer to a sip_privacy_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_PRIVACY_REF().
#define SIPTAG_PRIVACY_STR | ( | s | ) |
Tag list item for string with Privacy header value.
The SIPTAG_PRIVACY_STR() macro is used to include a tag item with a string containing value of a sip_privacy_t header in a tag list.
s | pointer to a string containing Privacy header value, or NULL. |
The string in SIPTAG_PRIVACY_STR() can be converted to a sip_privacy_t header structure by giving the string s has second argument to function sip_privacy_make().
The corresponding tag taking reference parameter is SIPTAG_PRIVACY_STR_REF().
|
inline |
Test if header object is instance of sip_privacy_t.
Check if the header class is an instance of Privacy 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 privacy |
0 | (false) otherwise |
|
inline |
Copy a list of Privacy header header structures sip_privacy_t.
The function sip_privacy_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 |
When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old hdr header, including the encoding of the old header, if present.
|
inline |
Duplicate a list of Privacy header header structures sip_privacy_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 |
When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.
|
inline |
Make a Privacy header from formatting result.
Make a new sip_privacy_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_privacy_t.
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
|
inline |
Initialize a structure sip_privacy_t.
An sip_privacy_t structure for Privacy header can be initialized with the sip_privacy_init() function/macro. For instance,
|
inline |
Make a Privacy header structure sip_privacy_t.
The function sip_privacy_make() makes a new sip_privacy_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 |
|
extern |
Header class for Privacy header.
The header class sip_privacy_class defines how a SIP Privacy header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_privacy_t header structure.