SIP Witch 1.9.15
[フレーム]
Data Structures | Macros | Typedefs | Functions
oSIP from header definition.
oSIP headers definitions
Collaboration diagram for oSIP from header definition.:

Data Structures

struct   osip_from
  Definition of the From header. More...
 

Macros

#define  osip_from_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_from_param_get_byname(header, name, dest)   osip_generic_param_get_byname((&(header)->gen_params),name,dest)
  Find a header parameter in a From element. More...
 
#define  osip_from_get_tag(header, dest)   osip_generic_param_get_byname((&(header)->gen_params), "tag",dest)
  Find the tag parameter in a From element. More...
 
#define  osip_from_set_tag(header, value)   osip_generic_param_add((&(header)->gen_params), osip_strdup("tag"),value)
  Allocate and add a tag parameter element in a Contact element. More...
 

Typedefs

typedef struct osip_from  osip_from_t
  Structure for From headers. More...
 

Functions

int  osip_from_init (osip_from_t **header)
  Allocate a From element. More...
 
void  osip_from_free (osip_from_t *header)
  Free a From element. More...
 
int  osip_from_parse (osip_from_t *header, const char *hvalue)
  Parse a From element. More...
 
int  osip_from_to_str (const osip_from_t *header, char **dest)
  Get a string representation of a From element. More...
 
int  osip_from_clone (const osip_from_t *header, osip_from_t **dest)
  Clone a From element. More...
 
void  osip_from_set_displayname (osip_from_t *header, char *value)
  Set the displayname in the From element. More...
 
char *  osip_from_get_displayname (osip_from_t *header)
  Get the displayname from a From header. More...
 
void  osip_from_set_url (osip_from_t *header, osip_uri_t *url)
  Set the url in the From element. More...
 
osip_uri_t *  osip_from_get_url (osip_from_t *header)
  Get the url from a From header. More...
 
int  osip_from_param_get (osip_from_t *header, int pos, osip_generic_param_t **dest)
  Get a header parameter from a From element. More...
 
int  osip_from_compare (osip_from_t *header1, osip_from_t *header2)
 
int  osip_from_tag_match (osip_from_t *from1, osip_from_t *from2)
  Check if the tags in the From headers match. More...
 

Detailed Description

Macro Definition Documentation

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

#include <osip_from.h>

Find the tag parameter in a From element.

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

Definition at line 137 of file osip_from.h.

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

#include <osip_from.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 123 of file osip_from.h.

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

#include <osip_from.h>

Find a header parameter in a From element.

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

Definition at line 130 of file osip_from.h.

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

#include <osip_from.h>

Allocate and add a tag parameter element in a Contact element.

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

Definition at line 143 of file osip_from.h.

Typedef Documentation

osip_from_t

#include <osip_from.h>

Structure for From headers.

Definition at line 42 of file osip_from.h.

Function Documentation

int osip_from_clone ( const osip_from_t *  header,
osip_from_t **  dest 
)

#include <osip_from.h>

Clone a From element.

Parameters
header The element to work on.
dest A pointer on the copy of the element.
int osip_from_compare ( osip_from_t *  header1,
osip_from_t *  header2 
)

#include <osip_from.h>

void osip_from_free ( osip_from_t *  header )

#include <osip_from.h>

Free a From element.

Parameters
header The element to work on.
char* osip_from_get_displayname ( osip_from_t *  header )

#include <osip_from.h>

Get the displayname from a From header.

Parameters
header The element to work on.
osip_uri_t* osip_from_get_url ( osip_from_t *  header )

#include <osip_from.h>

Get the url from a From header.

Parameters
header The element to work on.
int osip_from_init ( osip_from_t **  header )

#include <osip_from.h>

Allocate a From element.

Parameters
header The element to work on.
int osip_from_param_get ( osip_from_t *  header,
int  pos,
osip_generic_param_t **  dest 
)

#include <osip_from.h>

Get a header parameter from a From element.

Parameters
header The element to work on.
pos The index of the element to get.
dest A pointer on the element found.
int osip_from_parse ( osip_from_t *  header,
const char *  hvalue 
)

#include <osip_from.h>

Parse a From element.

Parameters
header The element to work on.
hvalue The string to parse.
void osip_from_set_displayname ( osip_from_t *  header,
char *  value 
)

#include <osip_from.h>

Set the displayname in the From element.

Parameters
header The element to work on.
value The value of the element.
void osip_from_set_url ( osip_from_t *  header,
osip_uri_t *  url 
)

#include <osip_from.h>

Set the url in the From element.

Parameters
header The element to work on.
url The value of the element.
int osip_from_tag_match ( osip_from_t *  from1,
osip_from_t *  from2 
)

#include <osip_from.h>

Check if the tags in the From headers match.

NOTE: THIS IS AN INTERNAL METHOD ONLY

Parameters
from1 The first From header.
from2 The second From header.
int osip_from_to_str ( const osip_from_t *  header,
char **  dest 
)

#include <osip_from.h>

Get a string representation of a From element.

Parameters
header The element to work on.
dest A pointer on the new allocated string.
Generated on Dec 21, 2017 for sipwitch-1.9.15 (*.h and *.cpp), libosip2-5.0.0 (*.h) and libeXosip2-4.0.0 (*.h), by   doxygen 1.8.6

AltStyle によって変換されたページ (->オリジナル) /