oSIP to header definition.

Collaboration diagram for oSIP to header definition.:

Macros
#define	osip_to_set_displayname(header, value)   osip_from_set_displayname((osip_from_t*)header,value)
	Set the displayname in the To element. More...
#define	osip_to_get_displayname(header)   osip_from_get_displayname((osip_from_t*)header)
	Get the displayname from a To header. More...
#define	osip_to_set_url(header, url)   osip_from_set_url((osip_from_t*)header,url)
	Set the url in the To element. More...
#define	osip_to_get_url(header)   osip_from_get_url((osip_from_t*)header)
	Get the url from a To header. More...
#define	osip_to_param_get(header, pos, dest)   osip_from_param_get((osip_from_t*)header,pos,dest)
	Get a header parameter from a To element. More...
#define	osip_to_param_get_byname(header, name, dest)   osip_generic_param_get_byname((&(header)->gen_params),name,dest)
	Find a header parameter in a To element. More...
#define	osip_to_param_add(header, name, value)   osip_generic_param_add((&(header)->gen_params),name,value)
	Allocate and add a generic parameter element in a list. More...
#define	osip_to_set_tag(header, value)   osip_generic_param_add((&(header)->gen_params), osip_strdup("tag"),value)
	Allocate and add a tag parameter element in a list. More...
#define	osip_to_get_tag(header, dest)   osip_generic_param_get_byname((&(header)->gen_params), "tag",dest)
	Find a tag parameter in a To element. More...
#define	osip_to_compare(header1, header2)   osip_from_compare((osip_from_t *)header1, (osip_from_t *)header2)

Typedefs
typedef osip_from_t	osip_to_t
	Structure for To headers. More...

Functions
int	osip_to_init (osip_to_t **header)
	Allocate a To element. More...
void	osip_to_free (osip_to_t *header)
	Free a To element. More...
int	osip_to_parse (osip_to_t *header, const char *hvalue)
	Parse a To element. More...
int	osip_to_to_str (const osip_to_t *header, char **dest)
	Get a string representation of a To element. More...
int	osip_to_clone (const osip_to_t *header, osip_to_t **dest)
	Clone a To element. More...
int	osip_to_tag_match (osip_to_t *to1, osip_to_t *to2)
	Check if the tags in the To headers match. More...

Detailed Description

Macro Definition Documentation

#define osip_to_compare	(		header1,
			header2
	)		osip_from_compare((osip_from_t *)header1, (osip_from_t *)header2)

#include <osip_to.h>

Definition at line 151 of file osip_to.h.

#define osip_to_get_displayname

(

header

)

osip_from_get_displayname((osip_from_t*)header)

#include <osip_to.h>

Get the displayname from a To header.

Parameters

header

The element to work on.

Definition at line 102 of file osip_to.h.

#define osip_to_get_tag	(		header,
			dest
	)		osip_generic_param_get_byname((&(header)->gen_params), "tag",dest)

#include <osip_to.h>

Find a tag parameter in a To element.

Parameters

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

Definition at line 147 of file osip_to.h.

#define osip_to_get_url

(

header

)

osip_from_get_url((osip_from_t*)header)

#include <osip_to.h>

Get the url from a To header.

Parameters

header

The element to work on.

Definition at line 113 of file osip_to.h.

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

#include <osip_to.h>

Allocate and add a generic parameter element in a list.

Parameters

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

Definition at line 134 of file osip_to.h.

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

#include <osip_to.h>

Get a header parameter from a To 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 120 of file osip_to.h.

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

#include <osip_to.h>

Find a header parameter in a To element.

Parameters

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

Definition at line 127 of file osip_to.h.

#define osip_to_set_displayname	(		header,
			value
	)		osip_from_set_displayname((osip_from_t*)header,value)

#include <osip_to.h>

Set the displayname in the To element.

Parameters

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

Definition at line 97 of file osip_to.h.

#define osip_to_set_tag	(		header,
			value
	)		osip_generic_param_add((&(header)->gen_params), osip_strdup("tag"),value)

#include <osip_to.h>

Allocate and add a tag parameter element in a list.

Parameters

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

Definition at line 141 of file osip_to.h.

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

#include <osip_to.h>

Set the url in the To element.

Parameters

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

Definition at line 108 of file osip_to.h.

Typedef Documentation

osip_to_t

#include <osip_to.h>

Structure for To headers.

Definition at line 41 of file osip_to.h.

Function Documentation

int osip_to_clone	(	const osip_to_t *	header,
		osip_to_t **	dest
	)

#include <osip_to.h>

Clone a To element.

Parameters

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

void osip_to_free

(

osip_to_t *

header

)

#include <osip_to.h>

Free a To element.

Parameters

header

The element to work on.

int osip_to_init

(

osip_to_t **

header

)

#include <osip_to.h>

Allocate a To element.

Parameters

header

The element to work on.

int osip_to_parse	(	osip_to_t *	header,
		const char *	hvalue
	)

#include <osip_to.h>

Parse a To element.

Parameters

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

int osip_to_tag_match	(	osip_to_t *	to1,
		osip_to_t *	to2
	)

#include <osip_to.h>

Check if the tags in the To headers match.

NOTE: THIS IS AN INTERNAL METHOD ONLY

Parameters

to1	The first To header.
to2	The second To header.

int osip_to_to_str	(	const osip_to_t *	header,
		char **	dest
	)

#include <osip_to.h>

Get a string representation of a To element.

Parameters

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