oSIP via header definition.
[oSIP headers definitions]


Classes

struct  osip_via
struct  osip_via

Defines

#define osip_via_set_version   via_set_version
#define osip_via_get_version   via_get_version
#define osip_via_set_protocol   via_set_protocol
#define osip_via_get_protocol   via_get_protocol
#define osip_via_set_host   via_set_host
#define osip_via_get_host   via_get_host
#define osip_via_set_port   via_set_port
#define osip_via_get_port   via_get_port
#define osip_via_set_comment   via_set_comment
#define osip_via_get_comment   via_get_comment
#define osip_via_set_hidden(header)   osip_generic_param_add((&(header)->via_params),osip_strdup("hidden"),NULL)
#define osip_via_set_ttl(header, value)   osip_generic_param_add((&(header)->via_params),osip_strdup("ttl"),value)
#define osip_via_set_maddr(header, value)   osip_generic_param_add((&(header)->via_params),osip_strdup("maddr"),value)
#define osip_via_set_received(header, value)   osip_generic_param_add((&(header)->via_params),osip_strdup("received"),value)
#define osip_via_set_branch(header, value)   osip_generic_param_add((&(header)->via_params),osip_strdup("branch"),value)
#define osip_via_param_add(header, name, value)   osip_generic_param_add((&(header)->via_params),name,value)
#define osip_via_param_get_byname(header, name, dest)   osip_generic_param_get_byname((&(header)->via_params),name,dest)

Typedefs

typedef struct osip_via osip_via_t

Functions

int osip_via_init (osip_via_t **header)
void osip_via_free (osip_via_t *header)
int osip_via_parse (osip_via_t *header, const char *hvalue)
int osip_via_to_str (const osip_via_t *header, char **dest)
int osip_via_clone (const osip_via_t *header, osip_via_t **dest)
void via_set_version (osip_via_t *header, char *value)
char * via_get_version (osip_via_t *header)
void via_set_protocol (osip_via_t *header, char *value)
char * via_get_protocol (osip_via_t *header)
void via_set_host (osip_via_t *header, char *value)
char * via_get_host (osip_via_t *header)
void via_set_port (osip_via_t *header, char *value)
char * via_get_port (osip_via_t *header)
void via_set_comment (osip_via_t *header, char *value)
char * via_get_comment (osip_via_t *header)
int osip_via_match (osip_via_t *via1, osip_via_t *via2)

Define Documentation

#define osip_via_get_comment   via_get_comment

Get the comment from a Via header.

Parameters:
header The element to work on.

#define osip_via_get_host   via_get_host

Get the host from a Via header.

Parameters:
header The element to work on.

#define osip_via_get_port   via_get_port

Get the port from a Via header.

Parameters:
header The element to work on.

#define osip_via_get_protocol   via_get_protocol

Get the protocol from a Via header.

Parameters:
header The element to work on.

#define osip_via_get_version   via_get_version

Get the SIP version from a Via header.

Parameters:
header The element to work on.

#define osip_via_param_add ( header,
name,
value   )     osip_generic_param_add((&(header)->via_params),name,value)

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.

#define osip_via_param_get_byname ( header,
name,
dest   )     osip_generic_param_get_byname((&(header)->via_params),name,dest)

Find a header parameter in a Via element.

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

#define osip_via_set_branch ( header,
value   )     osip_generic_param_add((&(header)->via_params),osip_strdup("branch"),value)

Allocate and add a branch parameter element in a list.

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

#define osip_via_set_comment   via_set_comment

Set the comment in the Via element.

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

#define osip_via_set_hidden ( header   )     osip_generic_param_add((&(header)->via_params),osip_strdup("hidden"),NULL)

Allocate and add a hidden parameter element in a list.

Parameters:
header The element to work on.

#define osip_via_set_host   via_set_host

Set the host in the Via element.

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

#define osip_via_set_maddr ( header,
value   )     osip_generic_param_add((&(header)->via_params),osip_strdup("maddr"),value)

Allocate and add a maddr parameter element in a list.

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

#define osip_via_set_port   via_set_port

Set the port in the Via element.

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

#define osip_via_set_protocol   via_set_protocol

Set the protocol in the Via element.

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

#define osip_via_set_received ( header,
value   )     osip_generic_param_add((&(header)->via_params),osip_strdup("received"),value)

Allocate and add a received parameter element in a list.

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

#define osip_via_set_ttl ( header,
value   )     osip_generic_param_add((&(header)->via_params),osip_strdup("ttl"),value)

Allocate and add a ttl parameter element in a list.

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

#define osip_via_set_version   via_set_version

Set the SIP version in the Via element.

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


Typedef Documentation

osip_via_t

Structure for Via headers.


Function Documentation

int osip_via_clone ( const osip_via_t header,
osip_via_t **  dest 
)

Clone a Via element.

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

void osip_via_free ( osip_via_t header  ) 

Free a Via element.

Parameters:
header The element to work on.

int osip_via_init ( osip_via_t **  header  ) 

Allocate a Via element.

Parameters:
header The element to work on.

int osip_via_match ( osip_via_t via1,
osip_via_t via2 
)

Check if the Via headers match. NOTE: THIS IS AN INTERNAL METHOD ONLY

Parameters:
via1 The first Via header.
via2 The second Via header.

int osip_via_parse ( osip_via_t header,
const char *  hvalue 
)

Parse a Via element.

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

int osip_via_to_str ( const osip_via_t header,
char **  dest 
)

Get a string representation of a Via element.

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


Generated on Wed Feb 13 01:03:29 2008 for libosip by  doxygen 1.5.4