The syntax of the Remote-Party-ID header is described as follows: More...
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)]
| #define sip_remote_party_id | ( | sip | ) |
Access a SIP Remote-Party-ID header structure sip_remote_party_id_t from sip_t.
| #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,
sip_remote_party_id_t sip_remote_party_id = SIP_REMOTE_PARTY_ID_INIT;
| #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.
| x | pointer to a sip_remote_party_id_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_REMOTE_PARTY_ID_REF().
| #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.
| s | pointer 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().
| 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.
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; } sip_remote_party_id_t;
| 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).
| header | pointer to the header structure to be tested |
| 1 | (true) if the header is an instance of header remote_party_id | |
| 0 | (false) otherwise |
| 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.
| 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.
remote_party_id = sip_remote_party_id_copy(home, sip->sip_remote_party_id);
| 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.
| 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.
remote_party_id = sip_remote_party_id_dup(home, sip->sip_remote_party_id);
| 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.
| home | memory home used to allocate new header structure. | |
| fmt | string used as a printf()-style format | |
| ... | argument list for format |
| 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,
sip_remote_party_id_t sip_remote_party_id; sip_remote_party_id_init(&sip_remote_party_id);
| 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.
| home | memory home used to allocate new header structure. | |
| s | string to be decoded as value of the new header structure |
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.
