RAck Header
[SIP Headers]

Collaboration diagram for RAck Header:


Detailed Description

The RAck header indicates the sequence number of the provisional response which is being acknowledged.

Its syntax is defined in draft-ietf-sip-100rel-04.txt section 5 as follows:

    RAck          =  "RAck" ":" response-num CSeq-num Method
    response-num  =  1*DIGIT
    CSeq-num      =  1*DIGIT


Data Structures

struct  sip_rack_s
 Structure for Rack header. More...

Defines

#define sip_rack(sip)
 Access a sip_rack_t from sip_t.
#define SIP_RACK_INIT()
 Initializer for structure sip_rack_t.
#define SIPTAG_RACK(x)
 Tag list item for pointer to a RAck header structure.
#define SIPTAG_RACK_REF(x)
 Tag list item for reference to a a RAck header pointer.
#define SIPTAG_RACK_STR(s)
 Tag list item for string with RAck header value.
#define SIPTAG_RACK_STR_REF(x)
 Tag list item for reference to a a RAck header string.

Enumerator

 sip_rack_hash
 @

Hash of RAck header.


Functions

SOFIAPUBFUN int sip_rack_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a RAck header.
SOFIAPUBFUN int sip_rack_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a RAck header.
sip_rack_tsip_rack_init (sip_rack_t x[1])
 Initialize a structure sip_rack_t.
int sip_is_rack (sip_header_t const *header)
 Test if header object is instance of sip_rack_t.
sip_rack_tsip_rack_dup (su_home_t *home, sip_rack_t const *hdr))
 Duplicate (deep copy) sip_rack_t.
sip_rack_tsip_rack_copy (su_home_t *home, sip_rack_t const *hdr))
 Copy a sip_rack_t header structure.
sip_rack_tsip_rack_make (su_home_t *home, char const *s))
 Make a header structure sip_rack_t.
sip_rack_tsip_rack_format (su_home_t *home, char const *fmt,...)))
 Make a RAck header from formatting result.

Variables

tag_typedef_t siptag_rack
 Tag for RAck header object.
tag_typedef_t siptag_rack_str
 Tag for string with RAck header value.
msg_hclass_t sip_rack_class []
 Header class for SIP RAck header.


Define Documentation

 
#define SIP_RACK_INIT (  ) 

Initializer for structure sip_rack_t.

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

#define SIPTAG_RACK (  ) 

Tag list item for pointer to a RAck header structure.

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

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

#define SIPTAG_RACK_STR (  ) 

Tag list item for string with RAck header value.

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

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

The corresponding tag taking reference parameter is SIPTAG_RACK_STR_REF().


Enumerator Documentation

sip_rack_hash

@

Hash of RAck header.


Function Documentation

int sip_is_rack ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_rack_t.

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

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

sip_rack_t * sip_rack_copy ( su_home_t home,
sip_rack_t const *  hdr 
) [inline]

Copy a sip_rack_t header structure.

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

sip_rack_t * sip_rack_dup ( su_home_t home,
sip_rack_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_rack_t.

The function sip_rack_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
   rack = sip_rack_dup(home, sip->sip_rack);
Returns:
The function sip_rack_dup() returns a pointer to the newly duplicated sip_rack_t header structure, or NULL upon an error.

sip_rack_t * sip_rack_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a RAck header from formatting result.

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

sip_rack_t* sip_rack_init ( sip_rack_t  x[1]  )  [inline]

Initialize a structure sip_rack_t.

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

sip_rack_t * sip_rack_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_rack_t.

The function sip_rack_make() makes a new sip_rack_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_rack_make() returns a pointer to newly maked sip_rack_t header structure, or NULL upon an error.


Variable Documentation

msg_hclass_t sip_rack_class[]

Header class for SIP RAck header.

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