Accept-Language Header
[SIP Headers]

Detailed Description

The Accept-Language header can be used to allow the client to indicate to the server in which language it would prefer to receive reason phrases, session descriptions or status responses carried as message bodies.

Its syntax is defined in [H14.4, S10.8] as follows:

    Accept-Language  =  "Accept-Language" HCOLON
                         [ language *(COMMA language) ]
    language         =  language-range *(SEMI accept-param)
    language-range   =  ( ( 1*8ALPHA *( "-" 1*8ALPHA ) ) / "*" )

The parsed Accept-Language header is stored in sip_accept_language_t structure.


Defines

#define sip_accept_language(sip)
 Access a SIP Accept-Language header structure sip_accept_language_t from sip_t.
#define SIP_ACCEPT_LANGUAGE_INIT()
 Initializer for structure sip_accept_language_t.
#define SIPTAG_ACCEPT_LANGUAGE(x)
 Tag list item for pointer to a Accept-Language header structure sip_accept_language_t.
#define SIPTAG_ACCEPT_LANGUAGE_REF(x)
 Tag list item for reference to a Accept-Language header pointer.
#define SIPTAG_ACCEPT_LANGUAGE_STR(s)
 Tag list item for string with Accept-Language header value.
#define SIPTAG_ACCEPT_LANGUAGE_STR_REF(x)
 Tag list item for reference to a Accept-Language header string.

Typedefs

typedef msg_accept_any_t sip_accept_language_t
 The structure sip_accept_language_t contains representation of SIP Accept-Language header.

Functions

issize_t sip_accept_language_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP Accept-Language header.
issize_t sip_accept_language_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP Accept-Language header.
sip_accept_language_t * sip_accept_language_init (sip_accept_language_t x[1])
 Initialize a structure sip_accept_language_t.
int sip_is_accept_language (sip_header_t const *header)
 Test if header object is instance of sip_accept_language_t.
sip_accept_language_t * sip_accept_language_dup (su_home_t *home, sip_accept_language_t const *hdr))
 Duplicate a list of Accept-Language header header structures sip_accept_language_t.
sip_accept_language_t * sip_accept_language_copy (su_home_t *home, sip_accept_language_t const *hdr))
 Copy a list of Accept-Language header header structures sip_accept_language_t.
sip_accept_language_t * sip_accept_language_make (su_home_t *home, char const *s))
 Make a Accept-Language header structure sip_accept_language_t.
sip_accept_language_t * sip_accept_language_format (su_home_t *home, char const *fmt,...)))
 Make a Accept-Language header from formatting result.

Variables

msg_hclass_t sip_accept_language_class []
 Header class for Accept-Language header.
tag_typedef_t siptag_accept_language
 Tag for Accept-Language header object.
tag_typedef_t siptag_accept_language_str
 Tag for string with Accept-Language header value.

Define Documentation

 
#define SIP_ACCEPT_LANGUAGE_INIT (   ) 
 

Initializer for structure sip_accept_language_t.

A static sip_accept_language_t structure for Accept-Language header must be initialized with the SIP_ACCEPT_LANGUAGE_INIT() macro. For instance, 

  sip_accept_language_t sip_accept_language = SIP_ACCEPT_LANGUAGE_INIT;

#define SIPTAG_ACCEPT_LANGUAGE (  x   ) 
 

Tag list item for pointer to a Accept-Language header structure sip_accept_language_t.

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

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

#define SIPTAG_ACCEPT_LANGUAGE_STR (  s   ) 
 

Tag list item for string with Accept-Language header value.

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

Parameters:
s pointer to a string containing Accept-Language header value, or NULL.
The string in SIPTAG_ACCEPT_LANGUAGE_STR() can be converted to a sip_accept_language_t header structure by giving the string s has second argument to function sip_accept_language_make().

The corresponding tag taking reference parameter is SIPTAG_ACCEPT_LANGUAGE_STR_REF().

Typedef Documentation

typedef struct msg_accept_any_s sip_accept_language_t
 

The structure sip_accept_language_t contains representation of SIP Accept-Language header.

The sip_accept_language_t is defined as follows: 

 typedef struct {
   msg_common_t        aa_common[1]; // Common fragment info
   sip_accept_language_t *aa_next;   // Pointer to next <language>
   char const            *aa_value;  // Language-range
   msg_param_t const     *aa_params; // List of accept-parameters
   char const            *aa_q;      // Value of q parameter
 } sip_accept_language_t;

Function Documentation

sip_accept_language_t * sip_accept_language_copy (  su_home_t *  home,
sip_accept_language_t const *  hdr
)  [inline]
 

Copy a list of Accept-Language header header structures sip_accept_language_t.

The function sip_accept_language_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
   accept_language = sip_accept_language_copy(home, sip->sip_accept_language);
Returns:
A pointer to newly copied header structure, or NULL upon an error.

sip_accept_language_t * sip_accept_language_dup (  su_home_t *  home,
sip_accept_language_t const *  hdr
)  [inline]
 

Duplicate a list of Accept-Language header header structures sip_accept_language_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
   accept_language = sip_accept_language_dup(home, sip->sip_accept_language);
Returns:
A pointer to the newly duplicated sip_accept_language_t header structure, or NULL upon an error.

sip_accept_language_t * sip_accept_language_format (  su_home_t *  home,
char const *  fmt,
  ...
)  [inline]
 

Make a Accept-Language header from formatting result.

Make a new sip_accept_language_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_accept_language_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_accept_language_t* sip_accept_language_init (  sip_accept_language_t  x[1]  )  [inline]
 

Initialize a structure sip_accept_language_t.

An sip_accept_language_t structure for Accept-Language header can be initialized with the sip_accept_language_init() function/macro. For instance, 

  sip_accept_language_t sip_accept_language;

  sip_accept_language_init(&sip_accept_language);

sip_accept_language_t * sip_accept_language_make (  su_home_t *  home,
char const *  s
)  [inline]
 

Make a Accept-Language header structure sip_accept_language_t.

The function sip_accept_language_make() makes a new sip_accept_language_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_accept_language_t header structure, or NULL upon an error.

int sip_is_accept_language (  sip_header_t const *  header  )  [inline]
 

Test if header object is instance of sip_accept_language_t.

Check if the header class is an instance of Accept-Language 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 accept_language
0 (false) otherwise

Variable Documentation

msg_hclass_t sip_accept_language_class[]
 

Header class for Accept-Language header.

The header class sip_accept_language_class defines how a SIP Accept-Language header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_accept_language_t header structure.

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