Collaboration diagram for Date Header:
![]() |
Its syntax is defined in [S10.21] and [H14.18] as follows:
Date = "Date" HCOLON SIP-date SIP-date = rfc1123-date rfc1123-date = wkday "," SP date1 SP time SP "GMT" date1 = 2DIGIT SP month SP 4DIGIT ; day month year (e.g., 02 Jun 1982) time = 2DIGIT ":" 2DIGIT ":" 2DIGIT ; 00:00:00 - 23:59:59 wkday = "Mon" / "Tue" / "Wed" / "Thu" / "Fri" / "Sat" / "Sun" month = "Jan" / "Feb" / "Mar" / "Apr" / "May" / "Jun" / "Jul" / "Aug" / "Sep" / "Oct" / "Nov" / "Dec"
Data Structures | |
struct | sip_date_s |
Structure for Date header. More... | |
Defines | |
#define | sip_date(sip) |
Access a sip_date_t from sip_t. | |
#define | SIP_DATE_INIT() |
Initializer for structure sip_date_t. | |
#define | SIPTAG_DATE(x) |
Tag list item for pointer to a Date header structure. | |
#define | SIPTAG_DATE_REF(x) |
Tag list item for reference to a a Date header pointer. | |
#define | SIPTAG_DATE_STR(s) |
Tag list item for string with Date header value. | |
#define | SIPTAG_DATE_STR_REF(x) |
Tag list item for reference to a a Date header string. | |
Typedefs | |
typedef sip_date_s | sip_date_t |
The structure sip_date_t contains representation of SIP Date header. | |
Enumerator | |
sip_date_hash | |
@ | |
Functions | |
sip_date_t * | sip_date_create (su_home_t *home, sip_time_t date) |
Create an Date header object. | |
SOFIAPUBFUN int | sip_date_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Date header. | |
SOFIAPUBFUN int | sip_date_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Date header. | |
sip_date_t * | sip_date_init (sip_date_t x[1]) |
Initialize a structure sip_date_t. | |
int | sip_is_date (sip_header_t const *header) |
Test if header object is instance of sip_date_t. | |
sip_date_t * | sip_date_dup (su_home_t *home, sip_date_t const *hdr)) |
Duplicate (deep copy) sip_date_t . | |
sip_date_t * | sip_date_copy (su_home_t *home, sip_date_t const *hdr)) |
Copy a sip_date_t header structure. | |
sip_date_t * | sip_date_make (su_home_t *home, char const *s)) |
Make a header structure sip_date_t. | |
sip_date_t * | sip_date_format (su_home_t *home, char const *fmt,...))) |
Make a Date header from formatting result. | |
Variables | |
tag_typedef_t | siptag_date |
Tag for Date header object. | |
tag_typedef_t | siptag_date_str |
Tag for string with Date header value. | |
msg_hclass_t | sip_date_class [] |
Header class for SIP Date header. |
#define SIP_DATE_INIT | ( | ) |
Initializer for structure sip_date_t.
A static sip_date_t structure must be initialized. The SIP_DATE_INIT() macro provides initialization value. For instance,
#define SIPTAG_DATE | ( | x | ) |
Tag list item for pointer to a Date header structure.
The SIPTAG_DATE() macro is used to include a tag item with a pointer to a sip_date_t object in a tag list.
x | pointer to a sip_date_t header structure, or NULL. |
#define SIPTAG_DATE_STR | ( | s | ) |
Tag list item for string with Date header value.
The SIPTAG_DATE_STR() macro is used to include a tag item with a string containing value of a sip_date_t header in a tag list.
s | pointer to a string containing sip_date_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_DATE_STR_REF().
typedef struct sip_date_s sip_date_t |
The structure sip_date_t contains representation of SIP Date header.
The sip_date_t is defined as follows:
typedef struct sip_date_s { sip_common_t d_common[1]; // Common fragment info sip_date_t *d_next; // Link to next (dummy) sip_time_t d_time; // Seconds since Jan 1, 1900 } sip_date_t;
sip_date_hash |
@
Hash of Date header.
sip_date_t * sip_date_copy | ( | su_home_t * | home, | |
sip_date_t const * | hdr | |||
) | [inline] |
Copy a sip_date_t header structure.
The function sip_date_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 |
date = sip_date_copy(home, sip->sip_date);
sip_date_t* sip_date_create | ( | su_home_t * | home, | |
sip_time_t | date | |||
) |
Create an Date header object.
The function sip_date_create() creates a Date header object with the date date. If
home | memory home | |
date | date expressed as seconds since Mon, 01 Jan 1900 00:00:00 |
sip_date_t * sip_date_dup | ( | su_home_t * | home, | |
sip_date_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_date_t
.
The function sip_date_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 |
date = sip_date_dup(home, sip->sip_date);
sip_date_t * sip_date_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Date header from formatting result.
The function sip_date_format() makes a new Date 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_date_t* sip_date_init | ( | sip_date_t | x[1] | ) | [inline] |
Initialize a structure sip_date_t.
An sip_date_t structure can be initialized with the sip_date_init() function/macro. For instance,
sip_date_t * sip_date_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_date_t.
The function sip_date_make() makes a new sip_date_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 |
int sip_is_date | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_date_t.
The function sip_is_date() returns true (nonzero) if the header class is an instance of Date header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Date header.
The header class sip_date_class defines how a SIP Date header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_date_t header structure.