Collaboration diagram for Min-Expires Header:
![]() |
The Min-Expires syntax is defined in [S20.23] as follows:
Min-Expires = "Min-Expires" HCOLON delta-seconds
Data Structures | |
struct | sip_min_expires_s |
Structure for Min-Expires header. More... | |
Defines | |
#define | sip_min_expires(sip) |
Access a sip_min_expires_t from sip_t. | |
#define | SIP_MIN_EXPIRES_INIT() |
Initializer for structure sip_min_expires_t. | |
#define | SIPTAG_MIN_EXPIRES(x) |
Tag list item for pointer to a Min-Expires header structure. | |
#define | SIPTAG_MIN_EXPIRES_REF(x) |
Tag list item for reference to a a Min-Expires header pointer. | |
#define | SIPTAG_MIN_EXPIRES_STR(s) |
Tag list item for string with Min-Expires header value. | |
#define | SIPTAG_MIN_EXPIRES_STR_REF(x) |
Tag list item for reference to a a Min-Expires header string. | |
Typedefs | |
typedef sip_min_expires_s | sip_min_expires_t |
The structure sip_min_expires_t contains representation of SIP Min-Expires header. | |
Enumerator | |
sip_min_expires_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_min_expires_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Min-Expires header. | |
SOFIAPUBFUN int | sip_min_expires_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Min-Expires header. | |
sip_min_expires_t * | sip_min_expires_init (sip_min_expires_t x[1]) |
Initialize a structure sip_min_expires_t. | |
int | sip_is_min_expires (sip_header_t const *header) |
Test if header object is instance of sip_min_expires_t. | |
sip_min_expires_t * | sip_min_expires_dup (su_home_t *home, sip_min_expires_t const *hdr)) |
Duplicate (deep copy) sip_min_expires_t . | |
sip_min_expires_t * | sip_min_expires_copy (su_home_t *home, sip_min_expires_t const *hdr)) |
Copy a sip_min_expires_t header structure. | |
sip_min_expires_t * | sip_min_expires_make (su_home_t *home, char const *s)) |
Make a header structure sip_min_expires_t. | |
sip_min_expires_t * | sip_min_expires_format (su_home_t *home, char const *fmt,...))) |
Make a Min-Expires header from formatting result. | |
Variables | |
tag_typedef_t | siptag_min_expires |
Tag for Min-Expires header object. | |
tag_typedef_t | siptag_min_expires_str |
Tag for string with Min-Expires header value. | |
msg_hclass_t | sip_min_expires_class [] |
Header class for SIP Min-Expires header. |
#define SIP_MIN_EXPIRES_INIT | ( | ) |
Initializer for structure sip_min_expires_t.
A static sip_min_expires_t structure must be initialized. The SIP_MIN_EXPIRES_INIT() macro provides initialization value. For instance,
#define SIPTAG_MIN_EXPIRES | ( | x | ) |
Tag list item for pointer to a Min-Expires header structure.
The SIPTAG_MIN_EXPIRES() macro is used to include a tag item with a pointer to a sip_min_expires_t object in a tag list.
x | pointer to a sip_min_expires_t header structure, or NULL. |
#define SIPTAG_MIN_EXPIRES_STR | ( | s | ) |
Tag list item for string with Min-Expires header value.
The SIPTAG_MIN_EXPIRES_STR() macro is used to include a tag item with a string containing value of a sip_min_expires_t header in a tag list.
s | pointer to a string containing sip_min_expires_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_MIN_EXPIRES_STR_REF().
typedef struct sip_min_expires_s sip_min_expires_t |
The structure sip_min_expires_t contains representation of SIP Min-Expires header.
The sip_min_expires_t is defined as follows:
typedef struct sip_min_expires_s { sip_common_t me_common[1]; // Common fragment info sip_unknown_t *me_next; // Link to next (dummy) unsigned long me_delta; // Seconds } sip_min_expires_t;
sip_min_expires_hash |
@
Hash of Min-Expires header.
int sip_is_min_expires | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_min_expires_t.
The function sip_is_min_expires() returns true (nonzero) if the header class is an instance of Min-Expires header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_min_expires_t * sip_min_expires_copy | ( | su_home_t * | home, | |
sip_min_expires_t const * | hdr | |||
) | [inline] |
Copy a sip_min_expires_t header structure.
The function sip_min_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 |
min_expires = sip_min_expires_copy(home, sip->sip_min_expires);
sip_min_expires_t * sip_min_expires_dup | ( | su_home_t * | home, | |
sip_min_expires_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_min_expires_t
.
The function sip_min_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 |
min_expires = sip_min_expires_dup(home, sip->sip_min_expires);
sip_min_expires_t * sip_min_expires_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Min-Expires header from formatting result.
The function sip_min_expires_format() makes a new Min-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_min_expires_t* sip_min_expires_init | ( | sip_min_expires_t | x[1] | ) | [inline] |
Initialize a structure sip_min_expires_t.
An sip_min_expires_t structure can be initialized with the sip_min_expires_init() function/macro. For instance,
sip_min_expires_t * sip_min_expires_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_min_expires_t.
The function sip_min_expires_make() makes a new sip_min_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 Min-Expires header.
The header class sip_min_expires_class defines how a SIP Min-Expires header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_min_expires_t header structure.