Collaboration diagram for Path Header:
![]() |
It is used in conjunction with SIP REGISTER requests and with 200 class messages in response to REGISTER (REGISTER responses).
Path = "Path" HCOLON path-value *(COMMA path-value)
path-value = name-addr *( SEMI rr-param )
Defines | |
#define | sip_path(sip) |
Access a sip_path_t from sip_t. | |
#define | SIP_PATH_INIT() |
Initializer for structure sip_path_t. | |
#define | SIPTAG_PATH(x) |
Tag list item for pointer to a Path header structure. | |
#define | SIPTAG_PATH_REF(x) |
Tag list item for reference to a a Path header pointer. | |
#define | SIPTAG_PATH_STR(s) |
Tag list item for string with Path header value. | |
#define | SIPTAG_PATH_STR_REF(x) |
Tag list item for reference to a a Path header string. | |
Typedefs | |
typedef sip_route_s | sip_path_t |
The structure sip_path_t contains representation of SIP Path header. | |
Enumerator | |
sip_path_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_path_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Path header. | |
SOFIAPUBFUN int | sip_path_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Path header. | |
sip_path_t * | sip_path_init (sip_path_t x[1]) |
Initialize a structure sip_path_t. | |
int | sip_is_path (sip_header_t const *header) |
Test if header object is instance of sip_path_t. | |
sip_path_t * | sip_path_dup (su_home_t *home, sip_path_t const *hdr)) |
Duplicate (deep copy) sip_path_t . | |
sip_path_t * | sip_path_copy (su_home_t *home, sip_path_t const *hdr)) |
Copy a sip_path_t header structure. | |
sip_path_t * | sip_path_make (su_home_t *home, char const *s)) |
Make a header structure sip_path_t. | |
sip_path_t * | sip_path_format (su_home_t *home, char const *fmt,...))) |
Make a Path header from formatting result. | |
Variables | |
tag_typedef_t | siptag_path |
Tag for Path header object. | |
tag_typedef_t | siptag_path_str |
Tag for string with Path header value. | |
msg_hclass_t | sip_path_class [] |
Header class for SIP Path header. |
#define SIP_PATH_INIT | ( | ) |
Initializer for structure sip_path_t.
A static sip_path_t structure must be initialized. The SIP_PATH_INIT() macro provides initialization value. For instance,
#define SIPTAG_PATH | ( | x | ) |
Tag list item for pointer to a Path header structure.
The SIPTAG_PATH() macro is used to include a tag item with a pointer to a sip_path_t object in a tag list.
x | pointer to a sip_path_t header structure, or NULL. |
#define SIPTAG_PATH_STR | ( | s | ) |
Tag list item for string with Path header value.
The SIPTAG_PATH_STR() macro is used to include a tag item with a string containing value of a sip_path_t header in a tag list.
s | pointer to a string containing sip_path_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_PATH_STR_REF().
typedef struct sip_route_s sip_path_t |
The structure sip_path_t contains representation of SIP Path header.
The sip_path_t is defined as follows:
typedef struct sip_route_s { sip_common_t r_common[1]; // Common fragment info sip_path_t *r_next; // Link to next Path char const *r_display; // Display name url_t r_url[1]; // Path URL msg_param_t const *r_params; // List of parameters } sip_path_t;
sip_path_hash |
@
Hash of Path header.
int sip_is_path | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_path_t.
The function sip_is_path() returns true (nonzero) if the header class is an instance of Path header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_path_t * sip_path_copy | ( | su_home_t * | home, | |
sip_path_t const * | hdr | |||
) | [inline] |
Copy a sip_path_t header structure.
The function sip_path_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 |
path = sip_path_copy(home, sip->sip_path);
sip_path_t * sip_path_dup | ( | su_home_t * | home, | |
sip_path_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_path_t
.
The function sip_path_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 |
path = sip_path_dup(home, sip->sip_path);
sip_path_t * sip_path_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Path header from formatting result.
The function sip_path_format() makes a new Path 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_path_t* sip_path_init | ( | sip_path_t | x[1] | ) | [inline] |
Initialize a structure sip_path_t.
An sip_path_t structure can be initialized with the sip_path_init() function/macro. For instance,
sip_path_t * sip_path_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_path_t.
The function sip_path_make() makes a new sip_path_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 Path header.
The header class sip_path_class defines how a SIP Path header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_path_t header structure.