Loading...
Searching...
No Matches
|
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.
|
|
◆ SIP_PRIVACY_INIT
#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 sip_privacy(sip)
Access a SIP Privacy header structure sip_privacy_t from sip_t.
Definition sip_protos.h:13935
#define SIP_PRIVACY_INIT()
Initializer for structure sip_privacy_t.
Definition sip_protos.h:13952
Structure for Privacy header.
Definition sip.h:790
◆ SIPTAG_PRIVACY
#define SIPTAG_PRIVACY |
( |
| x | ) |
|
◆ SIPTAG_PRIVACY_STR
#define SIPTAG_PRIVACY_STR |
( |
| s | ) |
|
◆ sip_privacy_t
@
The Privacy header is used by User-Agent to request privacy services from the network. Its syntax is defined in RFC 3323 as follows:
Privacy-hdr = "Privacy" HCOLON priv-value *(";" priv-value)
priv-value = "header" / "session" / "user" / "none" / "critical"
/ token
The parsed Privacy header is stored in sip_privacy_t structure.
The structure sip_privacy_t contains representation of a SIP Privacy header.
The sip_privacy_t is defined as follows:
struct sip_privacy_s sip_privacy_t
@
Definition sip.h:208
sip_error_t * priv_next
Dummy link.
Definition sip.h:792
sip_common_t priv_common[1]
Common fragment info.
Definition sip.h:791
msg_param_t const * priv_values
Privacy values
Definition sip.h:793
◆ sip_is_privacy()
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).
- Parameters
-
header | pointer to the header structure to be tested |
- Return values
-
1 | (true) if the header is an instance of header privacy |
0 | (false) otherwise |
◆ sip_privacy_copy()
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.
- Parameters
-
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.
- Example
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.
Definition sip_protos.h:14082
- Returns
- A pointer to newly copied header structure, or NULL upon an error.
◆ sip_privacy_dup()
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.
- Parameters
-
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.
- Example
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.
Definition sip_protos.h:14039
- Returns
- A pointer to the newly duplicated sip_privacy_t header structure, or NULL upon an error.
◆ sip_privacy_format()
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.
- Parameters
-
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
- Returns
- A pointer to newly makes header structure, or NULL upon an error.
◆ sip_privacy_init()
◆ sip_privacy_make()
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.
- Parameters
-
home | memory home used to allocate new header structure. |
s | string to be decoded as value of the new header structure |
- Returns
- A pointer to newly maked sip_privacy_t header structure, or NULL upon an error.
◆ sip_privacy_class
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.
Sofia-SIP 1.12.11devel -
Copyright (C) 2006 Nokia Corporation. All rights reserved.
Licensed under the terms of the GNU Lesser General Public License.