Collaboration diagram for Privacy Header:
![]() |
Its syntax is defined in [RFC3323] as follows:
Privacy-hdr = "Privacy" HCOLON priv-value *(";" priv-value) priv-value = "header" / "session" / "user" / "none" / "critical" / token
Data Structures | |
struct | sip_privacy_s |
Structure for Privacy header. More... | |
Defines | |
#define | sip_privacy(sip) |
Access a 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. | |
#define | SIPTAG_PRIVACY_REF(x) |
Tag list item for reference to a 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 a Privacy header string. | |
Enumerator | |
sip_privacy_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_privacy_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Privacy header. | |
SOFIAPUBFUN int | sip_privacy_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a 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 (deep copy) sip_privacy_t . | |
sip_privacy_t * | sip_privacy_copy (su_home_t *home, sip_privacy_t const *hdr)) |
Copy a sip_privacy_t header structure. | |
sip_privacy_t * | sip_privacy_make (su_home_t *home, char const *s)) |
Make a 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 | |
tag_typedef_t | siptag_privacy |
Tag for Privacy header object. | |
tag_typedef_t | siptag_privacy_str |
Tag for string with Privacy header value. | |
msg_hclass_t | sip_privacy_class [] |
Header class for SIP Privacy header. |
#define SIP_PRIVACY_INIT | ( | ) |
Initializer for structure sip_privacy_t.
A static sip_privacy_t structure must be initialized. The SIP_PRIVACY_INIT() macro provides initialization value. For instance,
#define SIPTAG_PRIVACY | ( | x | ) |
Tag list item for pointer to a Privacy header structure.
The SIPTAG_PRIVACY() macro is used to include a tag item with a pointer to a sip_privacy_t object in a tag list.
x | pointer to a sip_privacy_t header structure, or NULL. |
#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 sip_privacy_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_PRIVACY_STR_REF().
sip_privacy_hash |
@
Hash of Privacy header.
int sip_is_privacy | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_privacy_t.
The function sip_is_privacy() returns true (nonzero) if the header class is an instance of Privacy header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_privacy_t * sip_privacy_copy | ( | su_home_t * | home, | |
sip_privacy_t const * | hdr | |||
) | [inline] |
Copy a sip_privacy_t header structure.
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 header structure hdr.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
privacy = sip_privacy_copy(home, sip->sip_privacy);
sip_privacy_t * sip_privacy_dup | ( | su_home_t * | home, | |
sip_privacy_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_privacy_t
.
The function sip_privacy_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 |
privacy = sip_privacy_dup(home, sip->sip_privacy);
sip_privacy_t * sip_privacy_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Privacy header from formatting result.
The function sip_privacy_format() makes a new Privacy 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_privacy_t* sip_privacy_init | ( | sip_privacy_t | x[1] | ) | [inline] |
Initialize a structure sip_privacy_t.
An sip_privacy_t structure can be initialized with the sip_privacy_init() function/macro. For instance,
sip_privacy_t * sip_privacy_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a 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 |
Header class for SIP 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.