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 parsed Session-Expires header is stored in sip_session_expires_t structure.
#define SIP_SESSION_EXPIRES_INIT | ( | ) |
Initializer for structure sip_session_expires_t.
A static sip_session_expires_t structure for Session-Expires header must be initialized with the SIP_SESSION_EXPIRES_INIT() macro. For instance,
#define SIPTAG_SESSION_EXPIRES | ( | x | ) |
Tag list item for pointer to a Session-Expires header structure sip_session_expires_t.
The SIPTAG_SESSION_EXPIRES() macro is used to include a tag item with a pointer to a sip_session_expires_t structure in a tag list.
x | pointer to a sip_session_expires_t 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 Session-Expires header value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SESSION_EXPIRES_STR_REF().
typedef struct sip_session_expires_s sip_session_expires_t |
The structure sip_session_expires_t contains representation of the SIP Session-Expires header.
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;
int sip_is_session_expires | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_session_expires_t.
Check if the header class is an instance of Session-Expires header object and return true (nonzero), otherwise return false (zero).
header | pointer to the header structure to be tested |
1 | (true) if the header is an instance of header session_expires | |
0 | (false) otherwise |
sip_session_expires_t * sip_session_expires_copy | ( | su_home_t * | home, | |
sip_session_expires_t const * | hdr | |||
) | [inline] |
Copy a list of Session-Expires header header structures sip_session_expires_t.
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 list of 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);
issize_t sip_session_expires_d | ( | su_home_t * | , | |
msg_header_t * | , | |||
char * | s, | |||
isize_t | slen | |||
) |
Parse a SIP Session-Expires header.
sip_session_expires_t * sip_session_expires_dup | ( | su_home_t * | home, | |
sip_session_expires_t const * | hdr | |||
) | [inline] |
Duplicate a list of Session-Expires header header structures sip_session_expires_t.
Duplicate 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);
issize_t sip_session_expires_e | ( | char | b[], | |
isize_t | bsiz, | |||
msg_header_t const * | h, | |||
int | flags | |||
) |
Print a SIP Session-Expires header.
sip_session_expires_t * sip_session_expires_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Session-Expires header from formatting result.
Make a new sip_session_expires_t 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 parses the formatting result to the structure sip_session_expires_t.
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 for Session-Expires header 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 Session-Expires 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 |
msg_hclass_t sip_session_expires_class[] |
Header class for 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.