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. More...
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
| #define sip_p_preferred_identity | ( | sip | ) |
Access a SIP P-Preferred-Identity header structure sip_p_preferred_identity_t from sip_t.
| #define SIP_P_PREFERRED_IDENTITY_INIT | ( | ) |
Initializer for structure sip_p_preferred_identity_t.
A static sip_p_preferred_identity_t structure for P-Preferred-Identity header must be initialized with the SIP_P_PREFERRED_IDENTITY_INIT() macro. For instance,
sip_p_preferred_identity_t sip_p_preferred_identity = SIP_P_PREFERRED_IDENTITY_INIT;
| #define SIPTAG_P_PREFERRED_IDENTITY | ( | x | ) |
Tag list item for pointer to a P-Preferred-Identity header structure sip_p_preferred_identity_t.
The SIPTAG_P_PREFERRED_IDENTITY() macro is used to include a tag item with a pointer to a sip_p_preferred_identity_t structure in a tag list.
| x | pointer to a sip_p_preferred_identity_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_P_PREFERRED_IDENTITY_REF().
| #define SIPTAG_P_PREFERRED_IDENTITY_STR | ( | s | ) |
Tag list item for string with P-Preferred-Identity header value.
The SIPTAG_P_PREFERRED_IDENTITY_STR() macro is used to include a tag item with a string containing value of a sip_p_preferred_identity_t header in a tag list.
| s | pointer to a string containing P-Preferred-Identity header value, or NULL. |
The string in SIPTAG_P_PREFERRED_IDENTITY_STR() can be converted to a sip_p_preferred_identity_t header structure by giving the string s has second argument to function sip_p_preferred_identity_make().
The corresponding tag taking reference parameter is SIPTAG_P_PREFERRED_IDENTITY_STR_REF().
| typedef struct sip_p_preferred_identity_s sip_p_preferred_identity_t |
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:
typedef struct sip_p_preferred_identity_s { sip_common_t ppid_common[1]; // Common fragment info sip_p_preferred_identity_t *ppid_next; // Link to next char const *ppid_display; // Display name url_t ppid_url[1]; // URL } sip_p_preferred_identity_t;
| 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).
| header | pointer to the header structure to be tested |
| 1 | (true) if the header is an instance of header p_preferred_identity | |
| 0 | (false) otherwise |
| sip_p_preferred_identity_t * sip_p_preferred_identity_copy | ( | su_home_t * | home, | |
| sip_p_preferred_identity_t const * | hdr | |||
| ) | [inline] |
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.
| 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.
p_preferred_identity = sip_p_preferred_identity_copy(home, sip->sip_p_preferred_identity);
| sip_p_preferred_identity_t * sip_p_preferred_identity_dup | ( | su_home_t * | home, | |
| sip_p_preferred_identity_t const * | hdr | |||
| ) | [inline] |
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.
| 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.
p_preferred_identity = sip_p_preferred_identity_dup(home, sip->sip_p_preferred_identity);
| sip_p_preferred_identity_t * sip_p_preferred_identity_format | ( | su_home_t * | home, | |
| char const * | fmt, | |||
| ... | ||||
| ) | [inline] |
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.
| home | memory home used to allocate new header structure. | |
| fmt | string used as a printf()-style format | |
| ... | argument list for format |
| sip_p_preferred_identity_t* sip_p_preferred_identity_init | ( | sip_p_preferred_identity_t | x[1] | ) | [inline] |
Initialize a structure sip_p_preferred_identity_t.
An sip_p_preferred_identity_t structure for P-Preferred-Identity header can be initialized with the sip_p_preferred_identity_init() function/macro. For instance,
sip_p_preferred_identity_t sip_p_preferred_identity; sip_p_preferred_identity_init(&sip_p_preferred_identity);
| sip_p_preferred_identity_t * sip_p_preferred_identity_make | ( | su_home_t * | home, | |
| char const * | s | |||
| ) | [inline] |
Make a P-Preferred-Identity header structure sip_p_preferred_identity_t.
The function sip_p_preferred_identity_make() makes a new sip_p_preferred_identity_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 P-Preferred-Identity header.
The header class sip_p_preferred_identity_class defines how a SIP P-Preferred-Identity header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_p_preferred_identity_t header structure.