oSIP route header definition.

Collaboration diagram for oSIP route header definition.:

Macros
#define	osip_route_clone   osip_from_clone
	Clone a Route element. More...
#define	osip_route_set_url(header, url)   osip_from_set_url((osip_from_t*)header,url)
	Set the url in the Route element. More...
#define	osip_route_get_url(header)   osip_from_get_url((osip_from_t*)header)
	Get the url from a Route header. More...
#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. More...
#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. More...
#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. More...

Typedefs
typedef osip_from_t	osip_route_t
	Structure for Route headers. More...

Functions
int	osip_route_init (osip_route_t **header)
	Allocate a Route element. More...
void	osip_route_free (osip_route_t *header)
	Free a Route element. More...
int	osip_route_parse (osip_route_t *header, const char *hvalue)
	Parse a Route element. More...
int	osip_route_to_str (const osip_route_t *header, char **dest)
	Get a string representation of a Route element. More...

Detailed Description

Macro Definition Documentation

#define osip_route_clone   osip_from_clone

#include <osip_route.h>

Clone a Route element.

Parameters

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

Definition at line 76 of file osip_route.h.

#define osip_route_get_url

(

header

)

osip_from_get_url((osip_from_t*)header)

#include <osip_route.h>

Get the url from a Route header.

Parameters

header

The element to work on.

Definition at line 94 of file osip_route.h.

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

#include <osip_route.h>

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.

Definition at line 108 of file osip_route.h.

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

#include <osip_route.h>

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.

Definition at line 101 of file osip_route.h.

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

#include <osip_route.h>

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.

Definition at line 115 of file osip_route.h.

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

#include <osip_route.h>

Set the url in the Route element.

Parameters

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

Definition at line 89 of file osip_route.h.

Typedef Documentation

osip_route_t

#include <osip_route.h>

Structure for Route headers.

Definition at line 41 of file osip_route.h.

Function Documentation

void osip_route_free

(

osip_route_t *

header

)

#include <osip_route.h>

Free a Route element.

Parameters

header

The element to work on.

int osip_route_init

(

osip_route_t **

header

)

#include <osip_route.h>

Allocate a Route element.

Parameters

header

The element to work on.

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

#include <osip_route.h>

Parse a Route element.

Parameters

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

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

#include <osip_route.h>

Get a string representation of a Route element.

Parameters

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