Service-Route Header [SIP Headers]

The "Service-Route" is a SIP extension header field (RFC 3608), which can contain a route vector that will direct requests through a specific sequence of proxies. More...

Defines
#define	sip_service_route(sip)
	Access a SIP Service-Route header structure sip_service_route_t from sip_t.
#define	SIP_SERVICE_ROUTE_INIT()
	Initializer for structure sip_service_route_t.
#define	SIPTAG_SERVICE_ROUTE(x)
	Tag list item for pointer to a Service-Route header structure sip_service_route_t.
#define	SIPTAG_SERVICE_ROUTE_REF(x)
	Tag list item for reference to a Service-Route header pointer.
#define	SIPTAG_SERVICE_ROUTE_STR(s)
	Tag list item for string with Service-Route header value.
#define	SIPTAG_SERVICE_ROUTE_STR_REF(x)
	Tag list item for reference to a Service-Route header string.
Typedefs
typedef struct sip_route_s	sip_service_route_t
	The structure sip_service_route_t contains representation of SIP Service-Route header.
Functions
issize_t	sip_service_route_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
	Parse a SIP Service-Route header.
issize_t	sip_service_route_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
	Print a SIP Service-Route header.
sip_service_route_t *	sip_service_route_init (sip_service_route_t x[1])
	Initialize a structure sip_service_route_t.
int	sip_is_service_route (sip_header_t const *header)
	Test if header object is instance of sip_service_route_t.
sip_service_route_t *	sip_service_route_dup (su_home_t *home, sip_service_route_t const *hdr))
	Duplicate a list of Service-Route header header structures sip_service_route_t.
sip_service_route_t *	sip_service_route_copy (su_home_t *home, sip_service_route_t const *hdr))
	Copy a list of Service-Route header header structures sip_service_route_t.
sip_service_route_t *	sip_service_route_make (su_home_t *home, char const *s))
	Make a Service-Route header structure sip_service_route_t.
sip_service_route_t *	sip_service_route_format (su_home_t *home, char const *fmt,...)))
	Make a Service-Route header from formatting result.
Variables
msg_hclass_t	sip_service_route_class []
	Header class for Service-Route header.
tag_typedef_t	siptag_service_route
	Tag for Service-Route header object.
tag_typedef_t	siptag_service_route_str
	Tag for string with Service-Route header value.

---

Detailed Description

The "Service-Route" is a SIP extension header field (RFC 3608), which can contain a route vector that will direct requests through a specific sequence of proxies.

A registrar may use a Service-Route header field to inform a UA of a service route that, if used by the UA, will provide services from a proxy or set of proxies associated with that registrar. The Service-Route header field may be included by a registrar in the response to a REGISTER request. The syntax for the Service-Route header field is:

    Service-Route = "Service-Route" HCOLON sr-value *(COMMA sr-value)
    sr-value  =  name-addr *( SEMI rr-param )

The parsed Service-Route header is stored in sip_service_route_t structure.

See also:

RFC 3608, Path, Route, Record-Route

---

Define Documentation

#define SIP_SERVICE_ROUTE_INIT

(

)

Initializer for structure sip_service_route_t.

A static sip_service_route_t structure for Service-Route header must be initialized with the SIP_SERVICE_ROUTE_INIT() macro. For instance,

  sip_service_route_t sip_service_route = SIP_SERVICE_ROUTE_INIT;

#define SIPTAG_SERVICE_ROUTE

(

x

)

Tag list item for pointer to a Service-Route header structure sip_service_route_t.

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

Parameters:

x

pointer to a sip_service_route_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_SERVICE_ROUTE_REF().

#define SIPTAG_SERVICE_ROUTE_STR

(

s

)

Tag list item for string with Service-Route header value.

The SIPTAG_SERVICE_ROUTE_STR() macro is used to include a tag item with a string containing value of a sip_service_route_t header in a tag list.

Parameters:

s

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

The string in SIPTAG_SERVICE_ROUTE_STR() can be converted to a sip_service_route_t header structure by giving the string s has second argument to function sip_service_route_make().

The corresponding tag taking reference parameter is SIPTAG_SERVICE_ROUTE_STR_REF().

---

Typedef Documentation

typedef struct sip_route_s sip_service_route_t

The structure sip_service_route_t contains representation of SIP Service-Route header.

The sip_service_route_t is defined as follows:

 typedef struct sip_route_s {
   sip_common_t        r_common[1];   // Common fragment info
   sip_service_route_t*r_next;        // Link to next @ServiceRoute
   char const         *r_display;     // Display name
   url_t               r_url[1];      // Service-Route URL
   msg_param_t const  *r_params;      // List of parameters
 } sip_service_route_t;

---

Function Documentation

int sip_is_service_route

(

sip_header_t const *

header

)

[inline]

Test if header object is instance of sip_service_route_t.

Check if the header class is an instance of Service-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 service_route
	0	(false) otherwise

sip_service_route_t * sip_service_route_copy	(	su_home_t *	home,
		sip_service_route_t const *	hdr
	)			[inline]

Copy a list of Service-Route header header structures sip_service_route_t.

The function sip_service_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

   service_route = sip_service_route_copy(home, sip->sip_service_route);

Returns:

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

sip_service_route_t * sip_service_route_dup	(	su_home_t *	home,
		sip_service_route_t const *	hdr
	)			[inline]

Duplicate a list of Service-Route header header structures sip_service_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

   service_route = sip_service_route_dup(home, sip->sip_service_route);

Returns:

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

sip_service_route_t * sip_service_route_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Service-Route header from formatting result.

Make a new sip_service_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_service_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_service_route_t* sip_service_route_init

(

sip_service_route_t

x[1]

)

[inline]

Initialize a structure sip_service_route_t.

An sip_service_route_t structure for Service-Route header can be initialized with the sip_service_route_init() function/macro. For instance,

  sip_service_route_t sip_service_route;

  sip_service_route_init(&sip_service_route);

sip_service_route_t * sip_service_route_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a Service-Route header structure sip_service_route_t.

The function sip_service_route_make() makes a new sip_service_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_service_route_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t sip_service_route_class[]

Header class for Service-Route header.

The header class sip_service_route_class defines how a SIP Service-Route header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_service_route_t header structure.