oSIP route header definition.

Macros
#define	osip_route_clone   osip_from_clone
#define	osip_route_set_url(header, url)   osip_from_set_url((osip_from_t *) header, url)
#define	osip_route_get_url(header)   osip_from_get_url((osip_from_t *) header)
#define	osip_route_param_get(header, pos, dest)   osip_from_param_get((osip_from_t *) header, pos, dest)
#define	osip_route_param_add(header, name, value)   osip_generic_param_add((&(header)->gen_params), name, value)
#define	osip_route_param_get_byname(header, name, dest)   osip_generic_param_get_byname((&(header)->gen_params), name, dest)

Typedefs
typedef osip_from_t	osip_route_t

Functions
int	osip_route_init (osip_route_t **header)
void	osip_route_free (osip_route_t *header)
int	osip_route_parse (osip_route_t *header, const char *hvalue)
int	osip_route_to_str (const osip_route_t *header, char **dest)

Detailed Description

Macro Definition Documentation

osip_route_clone

#define osip_route_clone   osip_from_clone

Clone a Route element.

Parameters

header	The element to work on.
dest	A pointer on the copy of the element.

osip_route_get_url

#define osip_route_get_url

(

header

)

osip_from_get_url((osip_from_t *) header)

Get the url from a Route header.

Parameters

header

The element to work on.

osip_route_param_add

#define osip_route_param_add	(		header,
			name,
			value
	)		osip_generic_param_add((&(header)->gen_params), name, value)

Allocate and add a generic parameter element in a Route element.

Parameters

header	The element to work on.
name	The token name.
value	The token value.

osip_route_param_get

#define osip_route_param_get	(		header,
			pos,
			dest
	)		osip_from_param_get((osip_from_t *) header, pos, dest)

Get a header parameter from a Route element.

Parameters

header	The element to work on.
pos	The index of the element to get.
dest	A pointer on the element found.

osip_route_param_get_byname

#define osip_route_param_get_byname	(		header,
			name,
			dest
	)		osip_generic_param_get_byname((&(header)->gen_params), name, dest)

Find a header parameter in a Route element.

Parameters

header	The element to work on.
name	The token name to search.
dest	A pointer on the element found.

osip_route_set_url

#define osip_route_set_url	(		header,
			url
	)		osip_from_set_url((osip_from_t *) header, url)

Set the url in the Route element.

Parameters

header	The element to work on.
url	The value of the element.

Typedef Documentation

osip_route_t

osip_route_t

Structure for Route headers.

Function Documentation

osip_route_free()

void osip_route_free

(

osip_route_t *

header

)

Free a Route element.

Parameters

header

The element to work on.

References osip_from_free().

Referenced by osip_message_free(), and osip_message_set_route().

osip_route_init()

int osip_route_init

(

osip_route_t **

header

)

Allocate a Route element.

Parameters

header

The element to work on.

References osip_from_init().

Referenced by osip_message_set_route().

osip_route_parse()

int osip_route_parse	(	osip_route_t *	header,
		const char *	hvalue
	)

Parse a Route element.

Parameters

header	The element to work on.
hvalue	The string to parse.

References osip_from_parse().

Referenced by osip_message_set_route().

osip_route_to_str()

int osip_route_to_str	(	const osip_route_t *	header,
		char **	dest
	)

Get a string representation of a Route element.

Parameters

header	The element to work on.
dest	A pointer on the new allocated string.

References osip_record_route_to_str().