sip 1.12.11devel
|
Data Structures | |
struct | sip_contact_s |
Structure for Contact header field. More... | |
Macros | |
#define | sip_contact(sip) |
Access a SIP Contact header structure sip_contact_t from sip_t. | |
#define | SIP_CONTACT_INIT() |
Initializer for structure sip_contact_t. | |
#define | SIPTAG_CONTACT(x) |
Tag list item for pointer to a Contact header structure sip_contact_t. | |
#define | SIPTAG_CONTACT_REF(x) |
Tag list item for reference to a Contact header pointer. | |
#define | SIPTAG_CONTACT_STR(s) |
Tag list item for string with Contact header value. | |
#define | SIPTAG_CONTACT_STR_REF(x) |
Tag list item for reference to a Contact header string. | |
Functions | |
issize_t | sip_contact_d (su_home_t *, msg_header_t *, char *s, isize_t slen) |
Parse a SIP Contact header. | |
issize_t | sip_contact_e (char b[], isize_t bsiz, msg_header_t const *h, int flags) |
Print a SIP Contact header. | |
sip_contact_t * | sip_contact_init (sip_contact_t x[1]) |
Initialize a structure sip_contact_t. | |
int | sip_is_contact (sip_header_t const *header) |
Test if header object is instance of sip_contact_t. | |
sip_contact_t * | sip_contact_dup (su_home_t *home, sip_contact_t const *hdr)) |
Duplicate a list of Contact header header structures sip_contact_t. | |
sip_contact_t * | sip_contact_copy (su_home_t *home, sip_contact_t const *hdr)) |
Copy a list of Contact header header structures sip_contact_t. | |
sip_contact_t * | sip_contact_make (su_home_t *home, char const *s)) |
Make a Contact header structure sip_contact_t. | |
sip_contact_t * | sip_contact_format (su_home_t *home, char const *fmt,...))) |
Make a Contact header from formatting result. | |
int | sip_contact_add_param (su_home_t *home, sip_contact_t *m, char const *param) |
Add a parameter to a Contact header object. | |
sip_contact_t * | sip_contact_create (su_home_t *home, url_string_t const *url, char const *p,...) |
Create a contact header. | |
Variables | |
msg_hclass_t | sip_contact_class [] |
Header class for Contact header. | |
tag_typedef_t | siptag_contact |
Tag for Contact header object. | |
tag_typedef_t | siptag_contact_str |
Tag for string with Contact header value. | |
#define SIP_CONTACT_INIT | ( | ) |
Initializer for structure sip_contact_t.
A static sip_contact_t structure for Contact header must be initialized with the SIP_CONTACT_INIT() macro. For instance,
#define SIPTAG_CONTACT | ( | x | ) |
Tag list item for pointer to a Contact header structure sip_contact_t.
The SIPTAG_CONTACT() macro is used to include a tag item with a pointer to a sip_contact_t structure in a tag list.
x | pointer to a sip_contact_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_CONTACT_REF().
#define SIPTAG_CONTACT_STR | ( | s | ) |
Tag list item for string with Contact header value.
The SIPTAG_CONTACT_STR() macro is used to include a tag item with a string containing value of a sip_contact_t header in a tag list.
s | pointer to a string containing Contact header value, or NULL. |
The string in SIPTAG_CONTACT_STR() can be converted to a sip_contact_t header structure by giving the string s has second argument to function sip_contact_make().
The corresponding tag taking reference parameter is SIPTAG_CONTACT_STR_REF().
int sip_contact_add_param | ( | su_home_t * | home, |
sip_contact_t * | m, | ||
char const * | param | ||
) |
Add a parameter to a Contact header object.
Add a parameter to a Contact object. It does not copy the contents of the string param
.
param
.home | memory home |
m | sip_contact_t object |
param | parameter string |
|
inline |
Copy a list of Contact header header structures sip_contact_t.
The function sip_contact_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.
sip_contact_t * sip_contact_create | ( | su_home_t * | home, |
url_string_t const * | url, | ||
char const * | p, | ||
... | |||
) |
Create a contact header.
Create a Contact header object.
Create a Contact header object with the given URL and list of parameters.
home | memory home |
url | URL (string or pointer to url_t) |
p,... | NULL-terminated list of Contact parameters |
|
inline |
Duplicate a list of Contact header header structures sip_contact_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.
|
inline |
Make a Contact header from formatting result.
Make a new sip_contact_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_contact_t.
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
|
inline |
Initialize a structure sip_contact_t.
An sip_contact_t structure for Contact header can be initialized with the sip_contact_init() function/macro. For instance,
|
inline |
Make a Contact header structure sip_contact_t.
The function sip_contact_make() makes a new sip_contact_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 |
|
inline |
Test if header object is instance of sip_contact_t.
Check if the header class is an instance of Contact 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 contact |
0 | (false) otherwise |
|
extern |
Header class for Contact header.
The header class sip_contact_class defines how a SIP Contact header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_contact_t header structure.