Call-Info Header
[SIP Headers]

Detailed Description

The Call-Info header provides additional information about the caller or callee.

Its syntax is defined in RFC 3261 as follows:

    Call-Info   =  "Call-Info" HCOLON info *(COMMA info)
    info        =  LAQUOT absoluteURI RAQUOT *( SEMI info-param)
    info-param  =  ( "purpose" EQUAL ( "icon" / "info"
                   / "card" / token ) ) / generic-param

The parsed Call-Info header is stored in sip_call_info_t structure.


Data Structures

struct  sip_call_info_s
 Structure for Call-Info header. More...

Defines

#define sip_call_info(sip)
 Access a SIP Call-Info header structure sip_call_info_t from sip_t.
#define SIP_CALL_INFO_INIT()
 Initializer for structure sip_call_info_t.
#define SIPTAG_CALL_INFO(x)
 Tag list item for pointer to a Call-Info header structure sip_call_info_t.
#define SIPTAG_CALL_INFO_REF(x)
 Tag list item for reference to a Call-Info header pointer.
#define SIPTAG_CALL_INFO_STR(s)
 Tag list item for string with Call-Info header value.
#define SIPTAG_CALL_INFO_STR_REF(x)
 Tag list item for reference to a Call-Info header string.

Typedefs

typedef sip_call_info_s sip_call_info_t
 The structure sip_call_info_t contains representation of an Call-Info header.

Functions

issize_t sip_call_info_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP Call-Info header.
issize_t sip_call_info_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP Call-Info header.
sip_call_info_t * sip_call_info_init (sip_call_info_t x[1])
 Initialize a structure sip_call_info_t.
int sip_is_call_info (sip_header_t const *header)
 Test if header object is instance of sip_call_info_t.
sip_call_info_t * sip_call_info_dup (su_home_t *home, sip_call_info_t const *hdr))
 Duplicate a list of Call-Info header header structures sip_call_info_t.
sip_call_info_t * sip_call_info_copy (su_home_t *home, sip_call_info_t const *hdr))
 Copy a list of Call-Info header header structures sip_call_info_t.
sip_call_info_t * sip_call_info_make (su_home_t *home, char const *s))
 Make a Call-Info header structure sip_call_info_t.
sip_call_info_t * sip_call_info_format (su_home_t *home, char const *fmt,...)))
 Make a Call-Info header from formatting result.

Variables

msg_hclass_t sip_call_info_class []
 Header class for Call-Info header.
tag_typedef_t siptag_call_info
 Tag for Call-Info header object.
tag_typedef_t siptag_call_info_str
 Tag for string with Call-Info header value.

Define Documentation

 
#define SIP_CALL_INFO_INIT (   ) 
 

Initializer for structure sip_call_info_t.

A static sip_call_info_t structure for Call-Info header must be initialized with the SIP_CALL_INFO_INIT() macro. For instance, 

  sip_call_info_t sip_call_info = SIP_CALL_INFO_INIT;

#define SIPTAG_CALL_INFO (  x   ) 
 

Tag list item for pointer to a Call-Info header structure sip_call_info_t.

The SIPTAG_CALL_INFO() macro is used to include a tag item with a pointer to a sip_call_info_t structure in a tag list.

Parameters:
x pointer to a sip_call_info_t structure, or NULL.
The corresponding tag taking reference parameter is SIPTAG_CALL_INFO_REF().

#define SIPTAG_CALL_INFO_STR (  s   ) 
 

Tag list item for string with Call-Info header value.

The SIPTAG_CALL_INFO_STR() macro is used to include a tag item with a string containing value of a sip_call_info_t header in a tag list.

Parameters:
s pointer to a string containing Call-Info header value, or NULL.
The string in SIPTAG_CALL_INFO_STR() can be converted to a sip_call_info_t header structure by giving the string s has second argument to function sip_call_info_make().

The corresponding tag taking reference parameter is SIPTAG_CALL_INFO_STR_REF().

Typedef Documentation

struct sip_call_info_s sip_call_info_t
 

The structure sip_call_info_t contains representation of an Call-Info header.

The sip_call_info_t is defined as follows: 

 struct sip_call_info_s
 {
   sip_common_t        ci_common[1]; // Common fragment info
   sip_call_info_t    *ci_next;      // Link to next @CallInfo
   url_t               ci_url[1];    // URI to call info
   msg_param_t const  *ci_params;    // List of parameters
   char const         *ci_purpose;   // Value of @b purpose parameter
 };

Function Documentation

sip_call_info_t * sip_call_info_copy (  su_home_t *  home,
sip_call_info_t const *  hdr
)  [inline]
 

Copy a list of Call-Info header header structures sip_call_info_t.

The function sip_call_info_copy() copies a header structure hdr. If the header structure hdr contains a reference (hdr->h_next) to a list of headers, all the headers in that list are copied, too. The function uses given memory home to allocate all the memory areas used to copy the list of header structure hdr.

Parameters:
home memory home used to allocate new structure
hdr pointer to the header structure to be copied
When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old hdr header, including the encoding of the old header, if present.

Example
   call_info = sip_call_info_copy(home, sip->sip_call_info);
Returns:
A pointer to newly copied header structure, or NULL upon an error.

sip_call_info_t * sip_call_info_dup (  su_home_t *  home,
sip_call_info_t const *  hdr
)  [inline]
 

Duplicate a list of Call-Info header header structures sip_call_info_t.

Duplicate a header structure hdr. If the header structure hdr contains a reference (hdr->x_next) to a list of headers, all the headers in the list are duplicated, too.

Parameters:
home memory home used to allocate new structure
hdr header structure to be duplicated
When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.

Example
   call_info = sip_call_info_dup(home, sip->sip_call_info);
Returns:
A pointer to the newly duplicated sip_call_info_t header structure, or NULL upon an error.

sip_call_info_t * sip_call_info_format (  su_home_t *  home,
char const *  fmt,
  ...
)  [inline]
 

Make a Call-Info header from formatting result.

Make a new sip_call_info_t object using formatting result as its value. The function first prints the arguments according to the format fmt specified. Then it allocates a new header structure, and parses the formatting result to the structure sip_call_info_t.

Parameters:
home memory home used to allocate new header structure.
fmt string used as a printf()-style format
... argument list for format
Returns:
A pointer to newly makes header structure, or NULL upon an error.

sip_call_info_t* sip_call_info_init (  sip_call_info_t  x[1]  )  [inline]
 

Initialize a structure sip_call_info_t.

An sip_call_info_t structure for Call-Info header can be initialized with the sip_call_info_init() function/macro. For instance, 

  sip_call_info_t sip_call_info;
 
  sip_call_info_init(&sip_call_info);

sip_call_info_t * sip_call_info_make (  su_home_t *  home,
char const *  s
)  [inline]
 

Make a Call-Info header structure sip_call_info_t.

The function sip_call_info_make() makes a new sip_call_info_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters:
home memory home used to allocate new header structure.
s string to be decoded as value of the new header structure
Returns:
A pointer to newly maked sip_call_info_t header structure, or NULL upon an error.

int sip_is_call_info (  sip_header_t const *  header  )  [inline]
 

Test if header object is instance of sip_call_info_t.

Check if the header class is an instance of Call-Info header object and return true (nonzero), otherwise return false (zero).

Parameters:
header pointer to the header structure to be tested
Return values:
1 (true) if the header is an instance of header call_info
0 (false) otherwise

Variable Documentation

msg_hclass_t sip_call_info_class[]
 

Header class for Call-Info header.

The header class sip_call_info_class defines how a SIP Call-Info header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_call_info_t header structure.

Sofia-SIP 1.12.9devel1 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.