|
issize_t | sip_p_preferred_identity_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
| Parse a SIP P-Preferred-Identity header.
|
|
issize_t | sip_p_preferred_identity_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
| Print a SIP P-Preferred-Identity header.
|
|
sip_p_preferred_identity_t * | sip_p_preferred_identity_init (sip_p_preferred_identity_t x[1]) |
| Initialize a structure sip_p_preferred_identity_t. More...
|
|
int | sip_is_p_preferred_identity (sip_header_t const *header) |
| Test if header object is instance of sip_p_preferred_identity_t. More...
|
|
sip_p_preferred_identity_t * | sip_p_preferred_identity_dup (su_home_t *home, sip_p_preferred_identity_t const *hdr)) |
| Duplicate a list of P-Preferred-Identity header header structures sip_p_preferred_identity_t. More...
|
|
sip_p_preferred_identity_t * | sip_p_preferred_identity_copy (su_home_t *home, sip_p_preferred_identity_t const *hdr)) |
| Copy a list of P-Preferred-Identity header header structures sip_p_preferred_identity_t. More...
|
|
sip_p_preferred_identity_t * | sip_p_preferred_identity_make (su_home_t *home, char const *s)) |
| Make a P-Preferred-Identity header structure sip_p_preferred_identity_t. More...
|
|
sip_p_preferred_identity_t * | sip_p_preferred_identity_format (su_home_t *home, char const *fmt,...))) |
| Make a P-Preferred-Identity header from formatting result. More...
|
|
◆ sip_p_preferred_identity
#define sip_p_preferred_identity |
( |
|
sip | ) |
|
◆ SIP_P_PREFERRED_IDENTITY_INIT
#define SIP_P_PREFERRED_IDENTITY_INIT |
( |
| ) |
|
◆ SIPTAG_P_PREFERRED_IDENTITY
#define SIPTAG_P_PREFERRED_IDENTITY |
( |
|
x | ) |
|
◆ SIPTAG_P_PREFERRED_IDENTITY_STR
#define SIPTAG_P_PREFERRED_IDENTITY_STR |
( |
|
s | ) |
|
◆ sip_p_preferred_identity_t
@
The P-Preferred-Identity header is used used among trusted SIP entities (typically intermediaries) to carry the identity of the user sending a SIP message as it was verified by authentication. It is "defined" in RFC 3325 section 9.1 as follows:
PPreferredID = "P-Preferred-Identity" HCOLON PPreferredID-value
*(COMMA PPreferredID-value)
PPreferredID-value = name-addr / addr-spec
- See also
- RFC 3325, P-Asserted-Identity
- Since
- New in 1.12.7. In order to use P-Preferred-Identity header, initialize the SIP parser before calling nta_agent_create() or nua_create() with, e.g., sip_update_default_mclass(sip_extend_mclass(NULL)).
- Note
- The sip_t structure does not contain sip_p_preferred_identity field, but sip_p_preferred_identity() function should be used for accessing the P-Preferred-Identity header structure.
The structure sip_p_preferred_identity_t contains representation of SIP P-Preferred-Identity header.
The sip_p_preferred_identity_t is defined as follows:
◆ sip_is_p_preferred_identity()
int sip_is_p_preferred_identity |
( |
sip_header_t const * |
header | ) |
|
|
inline |
Test if header object is instance of sip_p_preferred_identity_t.
Check if the header class is an instance of P-Preferred-Identity 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 p_preferred_identity |
0 | (false) otherwise |
- Since
- New in
-
New in 1.12.7.
◆ sip_p_preferred_identity_copy()
Copy a list of P-Preferred-Identity header header structures sip_p_preferred_identity_t.
The function sip_p_preferred_identity_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
- Returns
- A pointer to newly copied header structure, or NULL upon an error.
- Since
- New in
-
New in 1.12.7.
◆ sip_p_preferred_identity_dup()
Duplicate a list of P-Preferred-Identity header header structures sip_p_preferred_identity_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
- Returns
- A pointer to the newly duplicated sip_p_preferred_identity_t header structure, or NULL upon an error.
- Since
- New in
-
New in 1.12.7.
◆ sip_p_preferred_identity_format()
Make a P-Preferred-Identity header from formatting result.
Make a new sip_p_preferred_identity_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_p_preferred_identity_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.
- Since
- New in
-
New in 1.12.7.
◆ sip_p_preferred_identity_init()
◆ sip_p_preferred_identity_make()
◆ sip_p_preferred_identity_class
struct sip_p_preferred_identity_s sip_p_preferred_identity_t
@
Definition: sip_extra.h:127
sip_p_preferred_identity_t * sip_p_preferred_identity_copy(su_home_t *home, sip_p_preferred_identity_t const *hdr))
Copy a list of P-Preferred-Identity header header structures sip_p_preferred_identity_t.
Definition: sip_extra.h:2090
sip_p_preferred_identity_t * ppid_next
Link to next identity.
Definition: sip_extra.h:136
sip_p_preferred_identity_t * sip_p_preferred_identity_dup(su_home_t *home, sip_p_preferred_identity_t const *hdr))
Duplicate a list of P-Preferred-Identity header header structures sip_p_preferred_identity_t.
Definition: sip_extra.h:2046
url_t ppid_url[1]
SIP, SIPS or TEL URL.
Definition: sip_extra.h:138
#define SIP_P_PREFERRED_IDENTITY_INIT()
Initializer for structure sip_p_preferred_identity_t.
Definition: sip_extra.h:1956
Structure for P-Preferred-Identity header.
Definition: sip_extra.h:133
char const * ppid_display
Display name.
Definition: sip_extra.h:137
sip_common_t ppid_common[1]
Common fragment info.
Definition: sip_extra.h:134
#define sip_p_preferred_identity(sip)
Access a SIP P-Preferred-Identity header structure sip_p_preferred_identity_t from sip_t.
Definition: sip_extra.h:1938
sip_p_preferred_identity_t * sip_p_preferred_identity_init(sip_p_preferred_identity_t x[1])
Initialize a structure sip_p_preferred_identity_t.
Definition: sip_extra.h:1975
Sofia-SIP 1.12.11devel -
Copyright (C) 2006 Nokia Corporation. All rights reserved.
Licensed under the terms of the GNU Lesser General Public License.