Accept Header
[SIP Headers]

Collaboration diagram for Accept Header:


Detailed Description

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Its syntax is defined in [H14.1, S10.6] as follows:

    Accept         =  "Accept" HCOLON
                       [ accept-range *(COMMA accept-range) ]
    accept-range   =  media-range *(SEMI accept-param)
    media-range    =  ( "*" "/" "*"
                      / ( m-type SLASH "*" )
                      / ( m-type SLASH m-subtype )
                      ) *( SEMI m-parameter )
    accept-param   =  ("q" EQUAL qvalue) / generic-param
    qvalue         =  ( "0" [ "." 0*3DIGIT ] )
                      / ( "1" [ "." 0*3("0") ] )
    generic-param  =  token [ EQUAL gen-value ]
    gen-value      =  token / host / quoted-string


Data Structures

struct  sip_accept_s
 Structure for Accept header. More...

Defines

#define sip_accept(sip)
 Access a sip_accept_t from sip_t.
#define SIP_ACCEPT_INIT()
 Initializer for structure sip_accept_t.
#define SIPTAG_ACCEPT(x)
 Tag list item for pointer to a Accept header structure.
#define SIPTAG_ACCEPT_REF(x)
 Tag list item for reference to a a Accept header pointer.
#define SIPTAG_ACCEPT_STR(s)
 Tag list item for string with Accept header value.
#define SIPTAG_ACCEPT_STR_REF(x)
 Tag list item for reference to a a Accept header string.

Typedefs

typedef sip_accept_s sip_accept_t
 The structure sip_accept_t contains representation of SIP Accept header.

Enumerator

 sip_accept_hash
 @

Hash of Accept header.


Functions

SOFIAPUBFUN int sip_accept_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a Accept header.
SOFIAPUBFUN int sip_accept_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a Accept header.
sip_accept_tsip_accept_init (sip_accept_t x[1])
 Initialize a structure sip_accept_t.
int sip_is_accept (sip_header_t const *header)
 Test if header object is instance of sip_accept_t.
sip_accept_tsip_accept_dup (su_home_t *home, sip_accept_t const *hdr))
 Duplicate (deep copy) sip_accept_t.
sip_accept_tsip_accept_copy (su_home_t *home, sip_accept_t const *hdr))
 Copy a sip_accept_t header structure.
sip_accept_tsip_accept_make (su_home_t *home, char const *s))
 Make a header structure sip_accept_t.
sip_accept_tsip_accept_format (su_home_t *home, char const *fmt,...)))
 Make a Accept header from formatting result.

Variables

tag_typedef_t siptag_accept
 Tag for Accept header object.
tag_typedef_t siptag_accept_str
 Tag for string with Accept header value.
msg_hclass_t sip_accept_class []
 Header class for SIP Accept header.


Define Documentation

 
#define SIP_ACCEPT_INIT (  ) 

Initializer for structure sip_accept_t.

A static sip_accept_t structure must be initialized. The SIP_ACCEPT_INIT() macro provides initialization value. For instance,

#define SIPTAG_ACCEPT (  ) 

Tag list item for pointer to a Accept header structure.

The SIPTAG_ACCEPT() macro is used to include a tag item with a pointer to a sip_accept_t object in a tag list.

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

#define SIPTAG_ACCEPT_STR (  ) 

Tag list item for string with Accept header value.

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

Parameters:
s pointer to a string containing sip_accept_t value, or NULL.
The string in SIPTAG_ACCEPT_STR() can be converted to a sip_accept_t header structure by giving the string s has second argument to function sip_accept_make().

The corresponding tag taking reference parameter is SIPTAG_ACCEPT_STR_REF().


Typedef Documentation

typedef struct sip_accept_s sip_accept_t

The structure sip_accept_t contains representation of SIP Accept header.

The sip_accept_t is defined as follows:

 typedef struct sip_accept_s {
   sip_common_t        ac_common[1]; // Common fragment info
   sip_accept_t       *ac_next;      // Pointer to next Accept header
   char const         *ac_type;      // Pointer to type/subtype
   char const         *ac_subtype;   // Points after first slash in type
   msg_param_t const  *ac_params;    // List of parameters
   msg_param_t         ac_q;         // Value of q parameter
 } sip_accept_t;


Enumerator Documentation

sip_accept_hash

@

Hash of Accept header.


Function Documentation

sip_accept_t * sip_accept_copy ( su_home_t home,
sip_accept_t const *  hdr 
) [inline]

Copy a sip_accept_t header structure.

The function sip_accept_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 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 = sip_accept_copy(home, sip->sip_accept);
Returns:
The function sip_accept_copy() returns a pointer to newly copied header structure, or NULL upon an error.

sip_accept_t * sip_accept_dup ( su_home_t home,
sip_accept_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_accept_t.

The function sip_accept_dup() duplicates 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 = sip_accept_dup(home, sip->sip_accept);
Returns:
The function sip_accept_dup() returns a pointer to the newly duplicated sip_accept_t header structure, or NULL upon an error.

sip_accept_t * sip_accept_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Accept header from formatting result.

The function sip_accept_format() makes a new Accept header 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 uses the formatting result as the header value.

Parameters:
home memory home used to allocate new header structure.
fmt string used as a printf()-style format
... argument list for format
Note:
This function is usually implemented as a macro calling msg_header_format().
Returns:
The function sip_accept_format() returns a pointer to newly makes header structure, or NULL upon an error.

sip_accept_t* sip_accept_init ( sip_accept_t  x[1]  )  [inline]

Initialize a structure sip_accept_t.

An sip_accept_t structure can be initialized with the sip_accept_init() function/macro. For instance,

sip_accept_t * sip_accept_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_accept_t.

The function sip_accept_make() makes a new sip_accept_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
Note:
This function is usually implemented as a macro calling sip_header_make().
Returns:
The function sip_accept_make() returns a pointer to newly maked sip_accept_t header structure, or NULL upon an error.

int sip_is_accept ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_accept_t.

The function sip_is_accept() returns true (nonzero) if the header class is an instance of Accept header object and false (zero) otherwise.

Parameters:
header pointer to the header structure to be tested
Returns:
The function sip_is_accept() returns true (nonzero) if the header object is an instance of header accept and false (zero) otherwise.


Variable Documentation

msg_hclass_t sip_accept_class[]

Header class for SIP Accept header.

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


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