Collaboration diagram for Timestamp Header:
![]() |
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 | |
@ | |
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_t * | sip_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_t * | sip_timestamp_dup (su_home_t *home, sip_timestamp_t const *hdr)) |
Duplicate (deep copy) sip_timestamp_t . | |
sip_timestamp_t * | sip_timestamp_copy (su_home_t *home, sip_timestamp_t const *hdr)) |
Copy a sip_timestamp_t header structure. | |
sip_timestamp_t * | sip_timestamp_make (su_home_t *home, char const *s)) |
Make a header structure sip_timestamp_t. | |
sip_timestamp_t * | sip_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 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 | ( | x | ) |
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.
x | pointer to a sip_timestamp_t header structure, or NULL. |
#define SIPTAG_TIMESTAMP_STR | ( | s | ) |
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.
s | pointer to a string containing sip_timestamp_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_TIMESTAMP_STR_REF().
sip_timestamp_hash |
@
Hash of Timestamp header.
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.
header | pointer to the header structure to be tested |
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.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
timestamp = sip_timestamp_copy(home, sip->sip_timestamp);
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.
home | memory home used to allocate new structure | |
hdr | header structure to be duplicated |
timestamp = sip_timestamp_dup(home, sip->sip_timestamp);
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.
home | memory home used to allocate new header structure. | |
fmt | string used as a printf()-style format | |
... | argument list for format |
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.
home | memory home used to allocate new header structure. | |
s | string to be decoded as value of the new header structure |
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.