Record-Route Header [SIP Headers]

The Record-Route headers are used to establish a route for transactions belonging to a session. More...

Defines
#define	sip_record_route(sip)
	Access a SIP Record-Route header structure 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 sip_record_route_t.
#define	SIPTAG_RECORD_ROUTE_REF(x)
	Tag list item for reference to 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 Record-Route header string.
Typedefs
typedef struct sip_route_s	sip_record_route_t
	The structure sip_record_route_t contains representation of SIP Record-Route header.
Functions
issize_t	sip_record_route_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
	Parse a SIP Record-Route header.
issize_t	sip_record_route_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
	Print a SIP 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 a list of Record-Route header header structures sip_record_route_t.
sip_record_route_t *	sip_record_route_copy (su_home_t *home, sip_record_route_t const *hdr))
	Copy a list of Record-Route header header structures sip_record_route_t.
sip_record_route_t *	sip_record_route_make (su_home_t *home, char const *s))
	Make a Record-Route 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.
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.
Variables
msg_hclass_t	sip_record_route_class []
	Header class for Record-Route header.
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.

---

Detailed Description

The Record-Route headers are used to establish a route for transactions belonging to a session.

The Record-Route header is defined in RFC 3261 as follows:

    Record-Route  =  "Record-Route" HCOLON rec-route *(COMMA rec-route)
    rec-route     =  name-addr *( SEMI rr-param )
    rr-param      =  generic-param

The parsed Record-Route header is stored in sip_record_route_t structure.

---

Define Documentation

#define SIP_RECORD_ROUTE_INIT

(

)

Initializer for structure sip_record_route_t.

A static sip_record_route_t structure for Record-Route header must be initialized with the SIP_RECORD_ROUTE_INIT() macro. For instance,

  sip_record_route_t sip_record_route = SIP_RECORD_ROUTE_INIT;

#define SIPTAG_RECORD_ROUTE

(

x

)

Tag list item for pointer to a Record-Route header structure sip_record_route_t.

The SIPTAG_RECORD_ROUTE() macro is used to include a tag item with a pointer to a sip_record_route_t structure in a tag list.

Parameters:

x

pointer to a sip_record_route_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_RECORD_ROUTE_REF().

#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.

Parameters:

s

pointer to a string containing Record-Route header value, or NULL.

The string in SIPTAG_RECORD_ROUTE_STR() can be converted to a sip_record_route_t header structure by giving the string s has second argument to function sip_record_route_make().

The corresponding tag taking reference parameter is SIPTAG_RECORD_ROUTE_STR_REF().

---

Typedef Documentation

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_route_s {
   sip_common_t        r_common[1];   // Common fragment info
   sip_record_route_t *r_next;        // Link to next <rec-route>
   char const         *r_display;     // Display name
   url_t               r_url[1];      // @RecordRoute URL
   msg_param_t const  *r_params;      // List of route parameters
 } sip_record_route_t;

---

Function Documentation

int sip_is_record_route

(

sip_header_t const *

header

)

[inline]

Test if header object is instance of sip_record_route_t.

Check if the header class is an instance of Record-Route header object and return true (nonzero), otherwise return false (zero).

Parameters:

header

pointer to the header structure to be tested

Return values:

	1	(true) if the header is an instance of header record_route
	0	(false) otherwise

sip_record_route_t * sip_record_route_copy	(	su_home_t *	home,
		sip_record_route_t const *	hdr
	)			[inline]

Copy a list of Record-Route header header structures sip_record_route_t.

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 list of header structure hdr.

Parameters:

	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.

Example

   record_route = sip_record_route_copy(home, sip->sip_record_route);

Returns:

A pointer to newly copied header structure, or NULL upon an error.

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.

Create a Record-Route header object.

Create a record-route entry from two URLs; first one provides the URL, second maddr parameter and port.

Parameters:

	home	memory home
	rq_url	route URL
	maddr	optional route address and port

Returns:

A pointer to newly created Record-Route header object when successful or NULL upon an error.

sip_record_route_t * sip_record_route_dup	(	su_home_t *	home,
		sip_record_route_t const *	hdr
	)			[inline]

Duplicate a list of Record-Route header header structures sip_record_route_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.

Parameters:

	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.

Example

   record_route = sip_record_route_dup(home, sip->sip_record_route);

Returns:

A pointer to the newly duplicated sip_record_route_t header structure, or NULL upon an error.

sip_record_route_t * sip_record_route_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Record-Route header from formatting result.

Make a new sip_record_route_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_record_route_t.

Parameters:

	home	memory home used to allocate new header structure.
	fmt	string used as a printf()-style format
	...	argument list for format

Returns:

A pointer to newly makes header structure, or NULL upon an error.

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 for Record-Route header can be initialized with the sip_record_route_init() function/macro. For instance,

  sip_record_route_t sip_record_route;

  sip_record_route_init(&sip_record_route);

sip_record_route_t * sip_record_route_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a Record-Route 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.

Parameters:

	home	memory home used to allocate new header structure.
	s	string to be decoded as value of the new header structure

Returns:

A pointer to newly maked sip_record_route_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t sip_record_route_class[]

Header class for 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.