Collaboration diagram for Expires Header:
![]() |
Its syntax is defined in [S10.24] as follows:
Expires = "Expires" HCOLON delta-seconds
Note that the first SIP revision (RFC 2543) also allowed absolute time in Expires.
Data Structures | |
struct | sip_expires_s |
Structure for Expires header. More... | |
Defines | |
#define | sip_expires(sip) |
Access a sip_expires_t from sip_t. | |
#define | SIP_EXPIRES_INIT() |
Initializer for structure sip_expires_t. | |
#define | SIPTAG_EXPIRES(x) |
Tag list item for pointer to a Expires header structure. | |
#define | SIPTAG_EXPIRES_REF(x) |
Tag list item for reference to a a Expires header pointer. | |
#define | SIPTAG_EXPIRES_STR(s) |
Tag list item for string with Expires header value. | |
#define | SIPTAG_EXPIRES_STR_REF(x) |
Tag list item for reference to a a Expires header string. | |
Typedefs | |
typedef sip_expires_s | sip_expires_t |
The structure sip_expires_t contains representation of SIP Expires header. | |
Enumerator | |
sip_expires_hash | |
@ | |
Functions | |
sip_expires_t * | sip_expires_create (su_home_t *home, sip_time_t delta) |
Create an Expires header object. | |
sip_time_t | sip_contact_expires (sip_contact_t const *m, sip_expires_t const *ex, sip_date_t const *date, sip_time_t def, sip_time_t now) |
Calculate expiration time of a Contact header. | |
SOFIAPUBFUN int | sip_expires_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Expires header. | |
SOFIAPUBFUN int | sip_expires_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Expires header. | |
sip_expires_t * | sip_expires_init (sip_expires_t x[1]) |
Initialize a structure sip_expires_t. | |
int | sip_is_expires (sip_header_t const *header) |
Test if header object is instance of sip_expires_t. | |
sip_expires_t * | sip_expires_dup (su_home_t *home, sip_expires_t const *hdr)) |
Duplicate (deep copy) sip_expires_t . | |
sip_expires_t * | sip_expires_copy (su_home_t *home, sip_expires_t const *hdr)) |
Copy a sip_expires_t header structure. | |
sip_expires_t * | sip_expires_make (su_home_t *home, char const *s)) |
Make a header structure sip_expires_t. | |
sip_expires_t * | sip_expires_format (su_home_t *home, char const *fmt,...))) |
Make a Expires header from formatting result. | |
Variables | |
tag_typedef_t | siptag_expires |
Tag for Expires header object. | |
tag_typedef_t | siptag_expires_str |
Tag for string with Expires header value. | |
msg_hclass_t | sip_expires_class [] |
Header class for SIP Expires header. |
#define SIP_EXPIRES_INIT | ( | ) |
Initializer for structure sip_expires_t.
A static sip_expires_t structure must be initialized. The SIP_EXPIRES_INIT() macro provides initialization value. For instance,
#define SIPTAG_EXPIRES | ( | x | ) |
Tag list item for pointer to a Expires header structure.
The SIPTAG_EXPIRES() macro is used to include a tag item with a pointer to a sip_expires_t object in a tag list.
x | pointer to a sip_expires_t header structure, or NULL. |
#define SIPTAG_EXPIRES_STR | ( | s | ) |
Tag list item for string with Expires header value.
The SIPTAG_EXPIRES_STR() macro is used to include a tag item with a string containing value of a sip_expires_t header in a tag list.
s | pointer to a string containing sip_expires_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_EXPIRES_STR_REF().
typedef struct sip_expires_s sip_expires_t |
The structure sip_expires_t contains representation of SIP Expires header.
The sip_expires_t is defined as follows:
typedef struct sip_expires_s { sip_common_t ex_common[1]; // Common fragment info sip_unknown_t *ex_next; // Link to next (dummy) sip_time_t ex_date; // Seconds since Jan 1, 1900 sip_time_t ex_delta; // ...or delta seconds } sip_expires_t;
sip_expires_hash |
@
Hash of Expires header.
sip_time_t sip_contact_expires | ( | sip_contact_t const * | m, | |
sip_expires_t const * | ex, | |||
sip_date_t const * | date, | |||
sip_time_t | def, | |||
sip_time_t | now | |||
) |
Calculate expiration time of a Contact header.
m | Contact header | |
ex | Expires header | |
date | Date header | |
def | Default expiration time | |
now | Current time. |
If now is 0, the function gets the current time using sip_now().
sip_expires_t * sip_expires_copy | ( | su_home_t * | home, | |
sip_expires_t const * | hdr | |||
) | [inline] |
Copy a sip_expires_t header structure.
The function sip_expires_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 |
expires = sip_expires_copy(home, sip->sip_expires);
sip_expires_t* sip_expires_create | ( | su_home_t * | home, | |
sip_time_t | delta | |||
) |
Create an Expires header object.
The function sip_expires_create() creates an Expires header object with the expiration time delta.
home | memory home | |
delta | relative expiration time in seconds |
sip_expires_t * sip_expires_dup | ( | su_home_t * | home, | |
sip_expires_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_expires_t
.
The function sip_expires_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 |
expires = sip_expires_dup(home, sip->sip_expires);
sip_expires_t * sip_expires_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Expires header from formatting result.
The function sip_expires_format() makes a new Expires 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_expires_t* sip_expires_init | ( | sip_expires_t | x[1] | ) | [inline] |
Initialize a structure sip_expires_t.
An sip_expires_t structure can be initialized with the sip_expires_init() function/macro. For instance,
sip_expires_t * sip_expires_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_expires_t.
The function sip_expires_make() makes a new sip_expires_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_expires | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_expires_t.
The function sip_is_expires() returns true (nonzero) if the header class is an instance of Expires header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Expires header.
The header class sip_expires_class defines how a SIP Expires header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_expires_t header structure.