sip  1.12.11devel
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerator | Functions | Variables
Remote-Party-ID Header

The syntax of the Remote-Party-ID header is described as follows: More...

Data Structures

struct  sip_remote_party_id_s
 Structure for Remote-Party-ID header. More...
 

Macros

#define sip_remote_party_id(sip)
 Access a SIP Remote-Party-ID header structure sip_remote_party_id_t from sip_t. More...
 
#define SIP_REMOTE_PARTY_ID_INIT()
 Initializer for structure sip_remote_party_id_t. More...
 
#define SIPTAG_REMOTE_PARTY_ID(x)
 Tag list item for pointer to a Remote-Party-ID header structure sip_remote_party_id_t. More...
 
#define SIPTAG_REMOTE_PARTY_ID_REF(x)
 Tag list item for reference to a Remote-Party-ID header pointer.
 
#define SIPTAG_REMOTE_PARTY_ID_STR(s)
 Tag list item for string with Remote-Party-ID header value. More...
 
#define SIPTAG_REMOTE_PARTY_ID_STR_REF(x)
 Tag list item for reference to a Remote-Party-ID header string.
 

Typedefs

typedef struct
sip_remote_party_id_s 
sip_remote_party_id_t
 The structure sip_remote_party_id_t contains representation of SIP Remote-Party-ID header. More...
 

Functions

issize_t sip_remote_party_id_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP Remote-Party-ID header.
 
issize_t sip_remote_party_id_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP Remote-Party-ID header.
 
sip_remote_party_id_tsip_remote_party_id_init (sip_remote_party_id_t x[1])
 Initialize a structure sip_remote_party_id_t. More...
 
int sip_is_remote_party_id (sip_header_t const *header)
 Test if header object is instance of sip_remote_party_id_t. More...
 
sip_remote_party_id_tsip_remote_party_id_dup (su_home_t *home, sip_remote_party_id_t const *hdr))
 Duplicate a list of Remote-Party-ID header header structures sip_remote_party_id_t. More...
 
sip_remote_party_id_tsip_remote_party_id_copy (su_home_t *home, sip_remote_party_id_t const *hdr))
 Copy a list of Remote-Party-ID header header structures sip_remote_party_id_t. More...
 
sip_remote_party_id_tsip_remote_party_id_make (su_home_t *home, char const *s))
 Make a Remote-Party-ID header structure sip_remote_party_id_t. More...
 
sip_remote_party_id_tsip_remote_party_id_format (su_home_t *home, char const *fmt,...)))
 Make a Remote-Party-ID header from formatting result. More...
 

Variables

msg_hclass_t sip_remote_party_id_class []
 Header class for Remote-Party-ID header. More...
 
tag_typedef_t siptag_remote_party_id
 Tag for Remote-Party-ID header object.
 
tag_typedef_t siptag_remote_party_id_str
 Tag for string with Remote-Party-ID header value.
 

Detailed Description

The syntax of the Remote-Party-ID header is described as follows:

Remote-Party-ID = "Remote-Party-ID" HCOLON rpid *(COMMA rpid)
rpid = [display-name] LAQUOT addr-spec RAQUOT
*(SEMI rpi-token)
rpi-token = rpi-screen / rpi-pty-type /
rpi-id-type / rpi-privacy / other-rpi-token
rpi-screen = "screen" EQUAL ("no" / "yes")
rpi-pty-type = "party" EQUAL ("calling" / "called" / token)
rpi-id-type = "id-type" EQUAL ("subscriber" / "user" /
"term" / token)
rpi-privacy = "privacy" EQUAL
( rpi-priv-element
/ (LDQUOT rpi-priv-element
*(COMMA rpi-priv-element) RDQUOT) )
rpi-priv-element = ("full" / "name" / "uri" / "off" / token)
["-" ( "network" / token )]
other-rpi-token = ["-"] token [EQUAL (token / quoted-string)]
See Also
sip_update_default_mclass(), draft-ietf-sip-privacy-04.txt, RFC 3325
Since
New in 1.12.7. In order to use Remote-Party-ID 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_remote_party_id field, but sip_remote_party_id() function should be used for accessing the Remote-Party-ID header structure.

Macro Definition Documentation

#define sip_remote_party_id (   sip)

Access a SIP Remote-Party-ID header structure sip_remote_party_id_t from sip_t.

Since
New in
New in 1.12.7.
#define SIP_REMOTE_PARTY_ID_INIT ( )

Initializer for structure sip_remote_party_id_t.

A static sip_remote_party_id_t structure for Remote-Party-ID header must be initialized with the SIP_REMOTE_PARTY_ID_INIT() macro. For instance,

Since
New in
New in 1.12.7.
#define SIPTAG_REMOTE_PARTY_ID (   x)

Tag list item for pointer to a Remote-Party-ID header structure sip_remote_party_id_t.

The SIPTAG_REMOTE_PARTY_ID() macro is used to include a tag item with a pointer to a sip_remote_party_id_t structure in a tag list.

Parameters
xpointer to a sip_remote_party_id_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_REMOTE_PARTY_ID_REF().

Since
New in
New in 1.12.7.
#define SIPTAG_REMOTE_PARTY_ID_STR (   s)

Tag list item for string with Remote-Party-ID header value.

The SIPTAG_REMOTE_PARTY_ID_STR() macro is used to include a tag item with a string containing value of a sip_remote_party_id_t header in a tag list.

Parameters
spointer to a string containing Remote-Party-ID header value, or NULL.

The string in SIPTAG_REMOTE_PARTY_ID_STR() can be converted to a sip_remote_party_id_t header structure by giving the string s has second argument to function sip_remote_party_id_make().

The corresponding tag taking reference parameter is SIPTAG_REMOTE_PARTY_ID_STR_REF().

Since
New in
New in 1.12.7.

Typedef Documentation

The structure sip_remote_party_id_t contains representation of SIP Remote-Party-ID header.

The sip_remote_party_id_t is defined as follows:

typedef struct sip_remote_party_id_s {
sip_common_t rpid_common[1]; // Common fragment info
sip_remote_party_id_t *rpid_next; // Link to next
char const *rpid_display; // Display name
url_t rpid_url[1]; // URL
sip_param_t const *rpid_params; // Parameters
// Shortcuts to screen, party, id-type and privacy parameters
char const *rpid_screen, *rpid_party, *rpid_id_type, *rpid_privacy;

Function Documentation

int sip_is_remote_party_id ( sip_header_t const *  header)
inline

Test if header object is instance of sip_remote_party_id_t.

Check if the header class is an instance of Remote-Party-ID header object and return true (nonzero), otherwise return false (zero).

Parameters
headerpointer to the header structure to be tested
Return values
1(true) if the header is an instance of header remote_party_id
0(false) otherwise
Since
New in
New in 1.12.7.
sip_remote_party_id_t * sip_remote_party_id_copy ( su_home_t home,
sip_remote_party_id_t const *  hdr 
)
inline

Copy a list of Remote-Party-ID header header structures sip_remote_party_id_t.

The function sip_remote_party_id_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
homememory home used to allocate new structure
hdrpointer 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
remote_party_id = sip_remote_party_id_copy(home, sip->sip_remote_party_id);
Returns
A pointer to newly copied header structure, or NULL upon an error.
Since
New in
New in 1.12.7.
sip_remote_party_id_t * sip_remote_party_id_dup ( su_home_t home,
sip_remote_party_id_t const *  hdr 
)
inline

Duplicate a list of Remote-Party-ID header header structures sip_remote_party_id_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
homememory home used to allocate new structure
hdrheader 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
remote_party_id = sip_remote_party_id_dup(home, sip->sip_remote_party_id);
Returns
A pointer to the newly duplicated sip_remote_party_id_t header structure, or NULL upon an error.
Since
New in
New in 1.12.7.
sip_remote_party_id_t * sip_remote_party_id_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Remote-Party-ID header from formatting result.

Make a new sip_remote_party_id_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_remote_party_id_t.

Parameters
homememory home used to allocate new header structure.
fmtstring 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_remote_party_id_t* sip_remote_party_id_init ( sip_remote_party_id_t  x[1])
inline

Initialize a structure sip_remote_party_id_t.

An sip_remote_party_id_t structure for Remote-Party-ID header can be initialized with the sip_remote_party_id_init() function/macro. For instance,

Since
New in
New in 1.12.7.
sip_remote_party_id_t * sip_remote_party_id_make ( su_home_t home,
char const *  s 
)
inline

Make a Remote-Party-ID header structure sip_remote_party_id_t.

The function sip_remote_party_id_make() makes a new sip_remote_party_id_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters
homememory home used to allocate new header structure.
sstring to be decoded as value of the new header structure
Returns
A pointer to newly maked sip_remote_party_id_t header structure, or NULL upon an error.
Since
New in
New in 1.12.7.

Variable Documentation

msg_hclass_t sip_remote_party_id_class[]

Header class for Remote-Party-ID header.

The header class sip_remote_party_id_class defines how a SIP Remote-Party-ID header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_remote_party_id_t header structure.

Since
New in
New in 1.12.7.

Sofia-SIP 1.12.11devel - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.