Collaboration diagram for Record-Route Header:
![]() |
The Record-Route header is defined in [S10.34] as follows:
Record-Route = "Record-Route" HCOLON rec-route *(COMMA rec-route)
rec-route = name-addr *( SEMI rr-param )
rr-param = generic-param
Defines | |
#define | sip_record_route(sip) |
Access a sip_record_route_t from sip_t. | |
#define | SIP_RECORD_ROUTE_INIT() |
Initializer for structure sip_record_route_t. | |
#define | SIPTAG_RECORD_ROUTE(x) |
Tag list item for pointer to a Record-Route header structure. | |
#define | SIPTAG_RECORD_ROUTE_REF(x) |
Tag list item for reference to a a Record-Route header pointer. | |
#define | SIPTAG_RECORD_ROUTE_STR(s) |
Tag list item for string with Record-Route header value. | |
#define | SIPTAG_RECORD_ROUTE_STR_REF(x) |
Tag list item for reference to a a Record-Route header string. | |
Typedefs | |
typedef sip_route_s | sip_record_route_t |
The structure sip_record_route_t contains representation of SIP Record-Route header. | |
Enumerator | |
sip_record_route_hash | |
@ | |
Functions | |
sip_record_route_t * | sip_record_route_create (su_home_t *home, url_t const *rq_url, url_t const *maddr) |
Create a Record-Route header object. | |
SOFIAPUBFUN int | sip_record_route_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Record-Route header. | |
SOFIAPUBFUN int | sip_record_route_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Record-Route header. | |
sip_record_route_t * | sip_record_route_init (sip_record_route_t x[1]) |
Initialize a structure sip_record_route_t. | |
int | sip_is_record_route (sip_header_t const *header) |
Test if header object is instance of sip_record_route_t. | |
sip_record_route_t * | sip_record_route_dup (su_home_t *home, sip_record_route_t const *hdr)) |
Duplicate (deep copy) sip_record_route_t . | |
sip_record_route_t * | sip_record_route_copy (su_home_t *home, sip_record_route_t const *hdr)) |
Copy a sip_record_route_t header structure. | |
sip_record_route_t * | sip_record_route_make (su_home_t *home, char const *s)) |
Make a header structure sip_record_route_t. | |
sip_record_route_t * | sip_record_route_format (su_home_t *home, char const *fmt,...))) |
Make a Record-Route header from formatting result. | |
Variables | |
tag_typedef_t | siptag_record_route |
Tag for Record-Route header object. | |
tag_typedef_t | siptag_record_route_str |
Tag for string with Record-Route header value. | |
msg_hclass_t | sip_record_route_class [] |
Header class for SIP Record-Route header. |
#define SIP_RECORD_ROUTE_INIT | ( | ) |
Initializer for structure sip_record_route_t.
A static sip_record_route_t structure must be initialized. The SIP_RECORD_ROUTE_INIT() macro provides initialization value. For instance,
#define SIPTAG_RECORD_ROUTE | ( | x | ) |
Tag list item for pointer to a Record-Route header structure.
The SIPTAG_RECORD_ROUTE() macro is used to include a tag item with a pointer to a sip_record_route_t object in a tag list.
x | pointer to a sip_record_route_t header structure, or NULL. |
#define SIPTAG_RECORD_ROUTE_STR | ( | s | ) |
Tag list item for string with Record-Route header value.
The SIPTAG_RECORD_ROUTE_STR() macro is used to include a tag item with a string containing value of a sip_record_route_t header in a tag list.
s | pointer to a string containing sip_record_route_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_RECORD_ROUTE_STR_REF().
typedef struct sip_record_route_s sip_record_route_t |
The structure sip_record_route_t contains representation of SIP Record-Route header.
The sip_record_route_t is defined as follows:
typedef struct sip_record_route_s { sip_common_t r_common[1]; // Common fragment info sip_route_t *r_next; // Link to next Record-Route char const *r_display; // Display name url_t r_url[1]; // Route URL msg_param_t const *r_params; // List of route parameters } sip_record_route_t;
sip_record_route_hash |
@
Hash of Record-Route header.
int sip_is_record_route | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_record_route_t.
The function sip_is_record_route() returns true (nonzero) if the header class is an instance of Record-Route header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_record_route_t * sip_record_route_copy | ( | su_home_t * | home, | |
sip_record_route_t const * | hdr | |||
) | [inline] |
Copy a sip_record_route_t header structure.
The function sip_record_route_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 |
record_route = sip_record_route_copy(home, sip->sip_record_route);
sip_record_route_t* sip_record_route_create | ( | su_home_t * | home, | |
url_t const * | rq_url, | |||
url_t const * | maddr | |||
) |
Create a Record-Route header object.
The function sip_record_route_create() creates a record-route entry from two URLs; first one provides the URL, second maddr parameter and port.
home | memory home | |
rq_url | route URL | |
maddr | optional route address and port |
sip_record_route_t * sip_record_route_dup | ( | su_home_t * | home, | |
sip_record_route_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_record_route_t
.
The function sip_record_route_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 |
record_route = sip_record_route_dup(home, sip->sip_record_route);
sip_record_route_t * sip_record_route_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Record-Route header from formatting result.
The function sip_record_route_format() makes a new Record-Route 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_record_route_t* sip_record_route_init | ( | sip_record_route_t | x[1] | ) | [inline] |
Initialize a structure sip_record_route_t.
An sip_record_route_t structure can be initialized with the sip_record_route_init() function/macro. For instance,
sip_record_route_t * sip_record_route_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_record_route_t.
The function sip_record_route_make() makes a new sip_record_route_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 Record-Route header.
The header class sip_record_route_class defines how a SIP Record-Route header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_record_route_t header structure.