Allow Header
[SIP Headers]

Collaboration diagram for Allow Header:


Detailed Description

The Allow header lists the set of methods supported by the user agent generating the message.

Its syntax is defined in [S10.10] as follows:

    Allow  =  "Allow" HCOLON [Method *(COMMA Method)]


Defines

#define sip_allow(sip)
 Access a sip_allow_t from sip_t.
#define SIP_ALLOW_INIT()
 Initializer for structure sip_allow_t.
#define SIPTAG_ALLOW(x)
 Tag list item for pointer to a Allow header structure.
#define SIPTAG_ALLOW_REF(x)
 Tag list item for reference to a a Allow header pointer.
#define SIPTAG_ALLOW_STR(s)
 Tag list item for string with Allow header value.
#define SIPTAG_ALLOW_STR_REF(x)
 Tag list item for reference to a a Allow header string.

Typedefs

typedef msg_list_t sip_allow_t
 The structure sip_allow_t contains representation of an Allow header.

Enumerator

 sip_allow_hash
 @

Hash of Allow header.


Functions

SOFIAPUBFUN int sip_allow_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a Allow header.
SOFIAPUBFUN int sip_allow_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a Allow header.
sip_allow_tsip_allow_init (sip_allow_t x[1])
 Initialize a structure sip_allow_t.
int sip_is_allow (sip_header_t const *header)
 Test if header object is instance of sip_allow_t.
sip_allow_tsip_allow_dup (su_home_t *home, sip_allow_t const *hdr))
 Duplicate (deep copy) sip_allow_t.
sip_allow_tsip_allow_copy (su_home_t *home, sip_allow_t const *hdr))
 Copy a sip_allow_t header structure.
sip_allow_tsip_allow_make (su_home_t *home, char const *s))
 Make a header structure sip_allow_t.
sip_allow_tsip_allow_format (su_home_t *home, char const *fmt,...)))
 Make a Allow header from formatting result.

Variables

tag_typedef_t siptag_allow
 Tag for Allow header object.
tag_typedef_t siptag_allow_str
 Tag for string with Allow header value.
msg_hclass_t sip_allow_class []
 Header class for SIP Allow header.


Define Documentation

 
#define SIP_ALLOW_INIT (  ) 

Initializer for structure sip_allow_t.

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

#define SIPTAG_ALLOW (  ) 

Tag list item for pointer to a Allow header structure.

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

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

#define SIPTAG_ALLOW_STR (  ) 

Tag list item for string with Allow header value.

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

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

The corresponding tag taking reference parameter is SIPTAG_ALLOW_STR_REF().


Typedef Documentation

struct msg_list_s sip_allow_t

The structure sip_allow_t contains representation of an Allow header.

The sip_allow_t is defined as follows:

 typedef struct msg_list_s
 {
   msg_common_t       k_common[1];  // Common fragment info
   msg_list_t        *k_next;         // Link to next header
   msg_param_t       *k_items;      // List of items
 } sip_allow_t;


Enumerator Documentation

sip_allow_hash

@

Hash of Allow header.


Function Documentation

sip_allow_t * sip_allow_copy ( su_home_t home,
sip_allow_t const *  hdr 
) [inline]

Copy a sip_allow_t header structure.

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

sip_allow_t * sip_allow_dup ( su_home_t home,
sip_allow_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_allow_t.

The function sip_allow_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
   allow = sip_allow_dup(home, sip->sip_allow);
Returns:
The function sip_allow_dup() returns a pointer to the newly duplicated sip_allow_t header structure, or NULL upon an error.

sip_allow_t * sip_allow_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Allow header from formatting result.

The function sip_allow_format() makes a new Allow 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_allow_format() returns a pointer to newly makes header structure, or NULL upon an error.

sip_allow_t* sip_allow_init ( sip_allow_t  x[1]  )  [inline]

Initialize a structure sip_allow_t.

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

  sip_allow_t sip_allow;
 
  sip_allow_init(&sip_allow);

sip_allow_t * sip_allow_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_allow_t.

The function sip_allow_make() makes a new sip_allow_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_allow_make() returns a pointer to newly maked sip_allow_t header structure, or NULL upon an error.

int sip_is_allow ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_allow_t.

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

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


Variable Documentation

msg_hclass_t sip_allow_class[]

Header class for SIP Allow header.

The header class sip_allow_class defines how a SIP Allow header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_allow_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.