Collaboration diagram for Contact Header:
![]() |
Its syntax is defined in [S10.14] as follows:
Contact = ("Contact" / "m" ) HCOLON ( STAR / (contact-param *(COMMA contact-param))) contact-param = (name-addr / addr-spec) *(SEMI contact-params) name-addr = [ display-name ] LAQUOT addr-spec RAQUOT addr-spec = SIP-URI / SIPS-URI / absoluteURI display-name = *(token LWS)/ quoted-string contact-params = c-p-q / c-p-expires / contact-extension c-p-q = "q" EQUAL qvalue c-p-expires = "expires" EQUAL delta-seconds contact-extension = generic-param delta-seconds = 1*DIGIT
Data Structures | |
struct | sip_contact_s |
Structure for Contact header. More... | |
Defines | |
#define | sip_contact(sip) |
Access a 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. | |
#define | SIPTAG_CONTACT_REF(x) |
Tag list item for reference to a 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 a Contact header string. | |
Typedefs | |
typedef sip_contact_s | sip_contact_t |
The structure sip_contact_t contains representation of SIP Contact header. | |
Enumerator | |
sip_contact_hash | |
@ | |
Functions | |
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 object. | |
SOFIAPUBFUN int | sip_contact_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Contact header. | |
SOFIAPUBFUN int | sip_contact_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a 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 (deep copy) sip_contact_t . | |
sip_contact_t * | sip_contact_copy (su_home_t *home, sip_contact_t const *hdr)) |
Copy a sip_contact_t header structure. | |
sip_contact_t * | sip_contact_make (su_home_t *home, char const *s)) |
Make a 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. | |
Variables | |
tag_typedef_t | siptag_contact |
Tag for Contact header object. | |
tag_typedef_t | siptag_contact_str |
Tag for string with Contact header value. | |
msg_hclass_t | sip_contact_class [] |
Header class for SIP Contact header. |
#define SIP_CONTACT_INIT | ( | ) |
Initializer for structure sip_contact_t.
A static sip_contact_t structure must be initialized. The SIP_CONTACT_INIT() macro provides initialization value. For instance,
#define SIPTAG_CONTACT | ( | x | ) |
Tag list item for pointer to a Contact header structure.
The SIPTAG_CONTACT() macro is used to include a tag item with a pointer to a sip_contact_t object in a tag list.
x | pointer to a sip_contact_t header structure, or NULL. |
#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 sip_contact_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_CONTACT_STR_REF().
typedef struct sip_contact_s sip_contact_t |
The structure sip_contact_t contains representation of SIP Contact header.
The sip_contact_t is defined as follows:
typedef struct sip_contact_s { sip_common_t m_common[1]; // Common fragment info sip_contact_t *m_next; // Link to next char const *m_display; // Display name url_t m_url[1]; // SIP URL msg_param_t const *m_params; // List of contact-params char const *m_comment; // Comment msg_param_t m_q; // Priority msg_param_t m_expires; // Expiration time } sip_contact_t;
sip_contact_hash |
@
Hash of Contact header.
int sip_contact_add_param | ( | su_home_t * | home, | |
sip_contact_t * | m, | |||
char const * | param | |||
) |
Add a parameter to a Contact header object.
The function sip_contact_add_param() adds 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 |
sip_contact_t * sip_contact_copy | ( | su_home_t * | home, | |
sip_contact_t const * | hdr | |||
) | [inline] |
Copy a sip_contact_t header structure.
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 header structure hdr.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
contact = sip_contact_copy(home, sip->sip_contact);
sip_contact_t* sip_contact_create | ( | su_home_t * | home, | |
url_string_t const * | url, | |||
char const * | p, | |||
... | ||||
) |
Create a Contact header object.
The function sip_contact_create() creates a Contact header object with the given URL and parameters.
home | memory home | |
url | URL (string or pointer to url_t) | |
p,... | NULL-terminated list of Contact parameters |
sip_contact_t * sip_contact_dup | ( | su_home_t * | home, | |
sip_contact_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_contact_t
.
The function sip_contact_dup() duplicates 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 |
contact = sip_contact_dup(home, sip->sip_contact);
sip_contact_t * sip_contact_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Contact header from formatting result.
The function sip_contact_format() makes a new Contact header 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 uses the formatting result as the header value.
home | memory home used to allocate new header structure. | |
fmt | string used as a printf()-style format | |
... | argument list for format |
sip_contact_t* sip_contact_init | ( | sip_contact_t | x[1] | ) | [inline] |
Initialize a structure sip_contact_t.
An sip_contact_t structure can be initialized with the sip_contact_init() function/macro. For instance,
sip_contact_t * sip_contact_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a 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 |
int sip_is_contact | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_contact_t.
The function sip_is_contact() returns true (nonzero) if the header class is an instance of Contact header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP 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.