Timestamp Header
[SIP Headers]

Collaboration diagram for Timestamp Header:


Detailed Description

The Timestamp header describes when the client sent the request to the server, and it is used by the client to adjust its retransmission intervals.

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

    Timestamp  =  "Timestamp" HCOLON 1*(DIGIT)
                   [ "." *(DIGIT) ] [ LWS delay ]
    delay      =  *(DIGIT) [ "." *(DIGIT) ]


Data Structures

struct  sip_timestamp_s
 Structure for Timestamp header. More...

Defines

#define sip_timestamp(sip)
 Access a sip_timestamp_t from sip_t.
#define SIP_TIMESTAMP_INIT()
 Initializer for structure sip_timestamp_t.
#define SIPTAG_TIMESTAMP(x)
 Tag list item for pointer to a Timestamp header structure.
#define SIPTAG_TIMESTAMP_REF(x)
 Tag list item for reference to a a Timestamp header pointer.
#define SIPTAG_TIMESTAMP_STR(s)
 Tag list item for string with Timestamp header value.
#define SIPTAG_TIMESTAMP_STR_REF(x)
 Tag list item for reference to a a Timestamp header string.

Enumerator

 sip_timestamp_hash
 @

Hash of Timestamp header.


Functions

SOFIAPUBFUN int sip_timestamp_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a Timestamp header.
SOFIAPUBFUN int sip_timestamp_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a Timestamp header.
sip_timestamp_tsip_timestamp_init (sip_timestamp_t x[1])
 Initialize a structure sip_timestamp_t.
int sip_is_timestamp (sip_header_t const *header)
 Test if header object is instance of sip_timestamp_t.
sip_timestamp_tsip_timestamp_dup (su_home_t *home, sip_timestamp_t const *hdr))
 Duplicate (deep copy) sip_timestamp_t.
sip_timestamp_tsip_timestamp_copy (su_home_t *home, sip_timestamp_t const *hdr))
 Copy a sip_timestamp_t header structure.
sip_timestamp_tsip_timestamp_make (su_home_t *home, char const *s))
 Make a header structure sip_timestamp_t.
sip_timestamp_tsip_timestamp_format (su_home_t *home, char const *fmt,...)))
 Make a Timestamp header from formatting result.

Variables

tag_typedef_t siptag_timestamp
 Tag for Timestamp header object.
tag_typedef_t siptag_timestamp_str
 Tag for string with Timestamp header value.
msg_hclass_t sip_timestamp_class []
 Header class for SIP Timestamp header.


Define Documentation

 
#define SIP_TIMESTAMP_INIT (  ) 

Initializer for structure sip_timestamp_t.

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

#define SIPTAG_TIMESTAMP (  ) 

Tag list item for pointer to a Timestamp header structure.

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

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

#define SIPTAG_TIMESTAMP_STR (  ) 

Tag list item for string with Timestamp header value.

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

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

The corresponding tag taking reference parameter is SIPTAG_TIMESTAMP_STR_REF().


Enumerator Documentation

sip_timestamp_hash

@

Hash of Timestamp header.


Function Documentation

int sip_is_timestamp ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_timestamp_t.

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

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

sip_timestamp_t * sip_timestamp_copy ( su_home_t home,
sip_timestamp_t const *  hdr 
) [inline]

Copy a sip_timestamp_t header structure.

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

sip_timestamp_t * sip_timestamp_dup ( su_home_t home,
sip_timestamp_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_timestamp_t.

The function sip_timestamp_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
   timestamp = sip_timestamp_dup(home, sip->sip_timestamp);
Returns:
The function sip_timestamp_dup() returns a pointer to the newly duplicated sip_timestamp_t header structure, or NULL upon an error.

sip_timestamp_t * sip_timestamp_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Timestamp header from formatting result.

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

sip_timestamp_t* sip_timestamp_init ( sip_timestamp_t  x[1]  )  [inline]

Initialize a structure sip_timestamp_t.

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

sip_timestamp_t * sip_timestamp_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_timestamp_t.

The function sip_timestamp_make() makes a new sip_timestamp_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_timestamp_make() returns a pointer to newly maked sip_timestamp_t header structure, or NULL upon an error.


Variable Documentation

msg_hclass_t sip_timestamp_class[]

Header class for SIP Timestamp header.

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