Collaboration diagram for Session-Expires Header:
![]() |
Its syntax is defined in RFC 4028 as follows:
Session-Expires = ("Session-Expires" | "x") HCOLON delta-seconds *(SEMI se-params) se-params = refresher-param / generic-param refresher-param = "refresher" EQUAL ("uas" / "uac")
The sip_session_expires_t is defined as follows:
typedef struct sip_session_expires_s { sip_common_t x_common[1]; sip_unknown_t *x_next; unsigned long x_delta; //Delta Seconds msg_param_t *x_params; char const *x_refresher; //Who will send the refresh UAS or UAC } sip_session_expires_t;
Data Structures | |
struct | sip_session_expires_s |
Structure for Session-Expires header. More... | |
Defines | |
#define | sip_session_expires(sip) |
Access a sip_session_expires_t from sip_t. | |
#define | SIP_SESSION_EXPIRES_INIT() |
Initializer for structure sip_session_expires_t. | |
#define | SIPTAG_SESSION_EXPIRES(x) |
Tag list item for pointer to a Session-Expires header structure. | |
#define | SIPTAG_SESSION_EXPIRES_REF(x) |
Tag list item for reference to a a Session-Expires header pointer. | |
#define | SIPTAG_SESSION_EXPIRES_STR(s) |
Tag list item for string with Session-Expires header value. | |
#define | SIPTAG_SESSION_EXPIRES_STR_REF(x) |
Tag list item for reference to a a Session-Expires header string. | |
Enumerator | |
sip_session_expires_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_session_expires_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Session-Expires header. | |
SOFIAPUBFUN int | sip_session_expires_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Session-Expires header. | |
sip_session_expires_t * | sip_session_expires_init (sip_session_expires_t x[1]) |
Initialize a structure sip_session_expires_t. | |
int | sip_is_session_expires (sip_header_t const *header) |
Test if header object is instance of sip_session_expires_t. | |
sip_session_expires_t * | sip_session_expires_dup (su_home_t *home, sip_session_expires_t const *hdr)) |
Duplicate (deep copy) sip_session_expires_t . | |
sip_session_expires_t * | sip_session_expires_copy (su_home_t *home, sip_session_expires_t const *hdr)) |
Copy a sip_session_expires_t header structure. | |
sip_session_expires_t * | sip_session_expires_make (su_home_t *home, char const *s)) |
Make a header structure sip_session_expires_t. | |
sip_session_expires_t * | sip_session_expires_format (su_home_t *home, char const *fmt,...))) |
Make a Session-Expires header from formatting result. | |
Variables | |
tag_typedef_t | siptag_session_expires |
Tag for Session-Expires header object. | |
tag_typedef_t | siptag_session_expires_str |
Tag for string with Session-Expires header value. | |
msg_hclass_t | sip_session_expires_class [] |
Header class for SIP Session-Expires header. |
#define SIP_SESSION_EXPIRES_INIT | ( | ) |
Initializer for structure sip_session_expires_t.
A static sip_session_expires_t structure must be initialized. The SIP_SESSION_EXPIRES_INIT() macro provides initialization value. For instance,
#define SIPTAG_SESSION_EXPIRES | ( | x | ) |
Tag list item for pointer to a Session-Expires header structure.
The SIPTAG_SESSION_EXPIRES() macro is used to include a tag item with a pointer to a sip_session_expires_t object in a tag list.
x | pointer to a sip_session_expires_t header structure, or NULL. |
#define SIPTAG_SESSION_EXPIRES_STR | ( | s | ) |
Tag list item for string with Session-Expires header value.
The SIPTAG_SESSION_EXPIRES_STR() macro is used to include a tag item with a string containing value of a sip_session_expires_t header in a tag list.
s | pointer to a string containing sip_session_expires_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SESSION_EXPIRES_STR_REF().
sip_session_expires_hash |
@
Hash of Session-Expires header.
int sip_is_session_expires | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_session_expires_t.
The function sip_is_session_expires() returns true (nonzero) if the header class is an instance of Session-Expires header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_session_expires_t * sip_session_expires_copy | ( | su_home_t * | home, | |
sip_session_expires_t const * | hdr | |||
) | [inline] |
Copy a sip_session_expires_t header structure.
The function sip_session_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 |
session_expires = sip_session_expires_copy(home, sip->sip_session_expires);
sip_session_expires_t * sip_session_expires_dup | ( | su_home_t * | home, | |
sip_session_expires_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_session_expires_t
.
The function sip_session_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 |
session_expires = sip_session_expires_dup(home, sip->sip_session_expires);
sip_session_expires_t * sip_session_expires_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Session-Expires header from formatting result.
The function sip_session_expires_format() makes a new Session-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_session_expires_t* sip_session_expires_init | ( | sip_session_expires_t | x[1] | ) | [inline] |
Initialize a structure sip_session_expires_t.
An sip_session_expires_t structure can be initialized with the sip_session_expires_init() function/macro. For instance,
sip_session_expires_t * sip_session_expires_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_session_expires_t.
The function sip_session_expires_make() makes a new sip_session_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 |
Header class for SIP Session-Expires header.
The header class sip_session_expires_class defines how a SIP Session-Expires header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_session_expires_t header structure.