Collaboration diagram for To Header:
![]() |
It is defined in [S10.43] as follows:
To = ( "To" / "t" ) HCOLON ( name-addr / addr-spec ) *( SEMI to-param ) to-param = tag-param / generic-param
Defines | |
#define | sip_to(sip) |
Access a sip_to_t from sip_t. | |
#define | SIP_TO_INIT() |
Initializer for structure sip_to_t. | |
#define | SIPTAG_TO(x) |
Tag list item for pointer to a To header structure. | |
#define | SIPTAG_TO_REF(x) |
Tag list item for reference to a a To header pointer. | |
#define | SIPTAG_TO_STR(s) |
Tag list item for string with To header value. | |
#define | SIPTAG_TO_STR_REF(x) |
Tag list item for reference to a a To header string. | |
Typedefs | |
typedef sip_addr_s | sip_to_t |
The structure sip_to_t contains representation of To header. | |
Enumerator | |
sip_to_hash | |
@ | |
Functions | |
sip_to_t * | sip_to_create (su_home_t *home, url_string_t const *url) |
Create a To header object. | |
int | sip_to_add_param (su_home_t *home, sip_to_t *to, char const *param) |
Add a parameter to an sip_to_t object. | |
SOFIAPUBFUN int | sip_to_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a To header. | |
SOFIAPUBFUN int | sip_to_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a To header. | |
sip_to_t * | sip_to_init (sip_to_t x[1]) |
Initialize a structure sip_to_t. | |
int | sip_is_to (sip_header_t const *header) |
Test if header object is instance of sip_to_t. | |
sip_to_t * | sip_to_dup (su_home_t *home, sip_to_t const *hdr)) |
Duplicate (deep copy) sip_to_t . | |
sip_to_t * | sip_to_copy (su_home_t *home, sip_to_t const *hdr)) |
Copy a sip_to_t header structure. | |
sip_to_t * | sip_to_make (su_home_t *home, char const *s)) |
Make a header structure sip_to_t. | |
sip_to_t * | sip_to_format (su_home_t *home, char const *fmt,...))) |
Make a To header from formatting result. | |
Variables | |
tag_typedef_t | siptag_to |
Tag for To header object. | |
tag_typedef_t | siptag_to_str |
Tag for string with To header value. | |
msg_hclass_t | sip_to_class [] |
Header class for SIP To header. |
#define SIP_TO_INIT | ( | ) |
Initializer for structure sip_to_t.
A static sip_to_t structure must be initialized. The SIP_TO_INIT() macro provides initialization value. For instance,
#define SIPTAG_TO | ( | x | ) |
Tag list item for pointer to a To header structure.
The SIPTAG_TO() macro is used to include a tag item with a pointer to a sip_to_t object in a tag list.
x | pointer to a sip_to_t header structure, or NULL. |
#define SIPTAG_TO_STR | ( | s | ) |
Tag list item for string with To header value.
The SIPTAG_TO_STR() macro is used to include a tag item with a string containing value of a sip_to_t header in a tag list.
s | pointer to a string containing sip_to_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_TO_STR_REF().
typedef struct sip_addr_s sip_to_t |
The structure sip_to_t contains representation of To header.
The sip_to_t is defined as follows:
typedef struct { sip_common_t a_common[1]; // Common fragment info sip_unknown_t *a_next; // Link to next (dummy) char const *a_display; // Display name url_t a_url[1]; // URL msg_param_t const *a_params; // List of to-params char const *a_comment; // Comment char const *a_tag; // Tag parameter } sip_to_t;
sip_to_hash |
@
Hash of To header.
int sip_is_to | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_to_t.
The function sip_is_to() returns true (nonzero) if the header class is an instance of To header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Add a parameter to an sip_to_t object.
The function sip_to_add_param() adds a parameter to an sip_to_t object.
param
.home | memory home | |
to | sip_to_t object | |
param | parameter string |
Copy a sip_to_t header structure.
The function sip_to_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 |
to = sip_to_copy(home, sip->sip_to);
sip_to_t* sip_to_create | ( | su_home_t * | home, | |
url_string_t const * | url | |||
) |
Create a To header object.
The function sip_to_create() creates a To header object with the given URL.
home | memory home | |
url | URL (string or pointer to url_t) |
Duplicate (deep copy) sip_to_t
.
The function sip_to_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 |
to = sip_to_dup(home, sip->sip_to);
Make a To header from formatting result.
The function sip_to_format() makes a new To 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 |
Initialize a structure sip_to_t.
An sip_to_t structure can be initialized with the sip_to_init() function/macro. For instance,
Make a header structure sip_to_t.
The function sip_to_make() makes a new sip_to_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 SIP To header.
The header class sip_to_class defines how a SIP To header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_to_t header structure.