Erroneous Headers
[SIP Headers]

Collaboration diagram for Erroneous Headers:


Detailed Description

The erroneous headers are stored in sip_error_t structure.

Note:
Other headers (like duplicate Content-Length headers) may be put into the list of erroneous headers (sip->sip_error). If the list of erroneous headers is processed, the header type must be validated first by calling sip_is_error() (or by other relevant tests).


Defines

#define sip_error(sip)
 Access a sip_error_t from sip_t.
#define SIP_ERROR_INIT()
 Initializer for structure sip_error_t.
#define SIPTAG_ERROR(x)
 Tag list item for pointer to a erroneous headers structure.
#define SIPTAG_ERROR_REF(x)
 Tag list item for reference to a a erroneous headers pointer.
#define SIPTAG_ERROR_STR(s)
 Tag list item for string with erroneous headers value.
#define SIPTAG_ERROR_STR_REF(x)
 Tag list item for reference to a a erroneous headers string.

Typedefs

typedef msg_error_t sip_error_t
 Erroneous headers.

Enumerator

 sip_error_hash
 @

Hash of erroneous headers.


Functions

SOFIAPUBFUN int sip_error_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a erroneous headers.
SOFIAPUBFUN int sip_error_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a erroneous headers.
sip_error_tsip_error_init (sip_error_t x[1])
 Initialize a structure sip_error_t.
int sip_is_error (sip_header_t const *header)
 Test if header object is instance of sip_error_t.
sip_error_tsip_error_dup (su_home_t *home, sip_error_t const *hdr))
 Duplicate (deep copy) sip_error_t.
sip_error_tsip_error_copy (su_home_t *home, sip_error_t const *hdr))
 Copy a sip_error_t header structure.
sip_error_tsip_error_make (su_home_t *home, char const *s))
 Make a header structure sip_error_t.
sip_error_tsip_error_format (su_home_t *home, char const *fmt,...)))
 Make a erroneous headers from formatting result.

Variables

tag_typedef_t siptag_error
 Tag for erroneous headers object.
tag_typedef_t siptag_error_str
 Tag for string with erroneous headers value.
msg_hclass_t sip_error_class []
 Header class for SIP erroneous headers.


Define Documentation

 
#define SIP_ERROR_INIT (  ) 

Initializer for structure sip_error_t.

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

#define SIPTAG_ERROR (  ) 

Tag list item for pointer to a erroneous headers structure.

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

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

#define SIPTAG_ERROR_STR (  ) 

Tag list item for string with erroneous headers value.

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

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

The corresponding tag taking reference parameter is SIPTAG_ERROR_STR_REF().


Enumerator Documentation

sip_error_hash

@

Hash of erroneous headers.


Function Documentation

sip_error_t * sip_error_copy ( su_home_t home,
sip_error_t const *  hdr 
) [inline]

Copy a sip_error_t header structure.

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

sip_error_t * sip_error_dup ( su_home_t home,
sip_error_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_error_t.

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

sip_error_t * sip_error_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a erroneous headers from formatting result.

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

sip_error_t* sip_error_init ( sip_error_t  x[1]  )  [inline]

Initialize a structure sip_error_t.

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

sip_error_t * sip_error_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_error_t.

The function sip_error_make() makes a new sip_error_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_error_make() returns a pointer to newly maked sip_error_t header structure, or NULL upon an error.

int sip_is_error ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_error_t.

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

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


Variable Documentation

msg_hclass_t sip_error_class[]

Header class for SIP erroneous headers.

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