Collaboration diagram for Min-SE Header:
![]() |
Its syntax is defined in RFC 4028 as follows:
MMin-SE = "Min-SE" HCOLON delta-seconds *(SEMI generic-param)
The sip_min_se_t is defined as follows:
typedef struct sip_min_se_s { sip_common_t min_common[1]; sip_unknown_t *min_next; unsigned long min_delta; // Delta seconds sip_params_t *min_params; // List of extension parameters } sip_min_se_t;
Data Structures | |
struct | sip_min_se_s |
Structure for Min-SE header. More... | |
Defines | |
#define | sip_min_se(sip) |
Access a sip_min_se_t from sip_t. | |
#define | SIP_MIN_SE_INIT() |
Initializer for structure sip_min_se_t. | |
#define | SIPTAG_MIN_SE(x) |
Tag list item for pointer to a Min-SE header structure. | |
#define | SIPTAG_MIN_SE_REF(x) |
Tag list item for reference to a a Min-SE header pointer. | |
#define | SIPTAG_MIN_SE_STR(s) |
Tag list item for string with Min-SE header value. | |
#define | SIPTAG_MIN_SE_STR_REF(x) |
Tag list item for reference to a a Min-SE header string. | |
Enumerator | |
sip_min_se_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_min_se_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Min-SE header. | |
SOFIAPUBFUN int | sip_min_se_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Min-SE header. | |
sip_min_se_t * | sip_min_se_init (sip_min_se_t x[1]) |
Initialize a structure sip_min_se_t. | |
int | sip_is_min_se (sip_header_t const *header) |
Test if header object is instance of sip_min_se_t. | |
sip_min_se_t * | sip_min_se_dup (su_home_t *home, sip_min_se_t const *hdr)) |
Duplicate (deep copy) sip_min_se_t . | |
sip_min_se_t * | sip_min_se_copy (su_home_t *home, sip_min_se_t const *hdr)) |
Copy a sip_min_se_t header structure. | |
sip_min_se_t * | sip_min_se_make (su_home_t *home, char const *s)) |
Make a header structure sip_min_se_t. | |
sip_min_se_t * | sip_min_se_format (su_home_t *home, char const *fmt,...))) |
Make a Min-SE header from formatting result. | |
Variables | |
tag_typedef_t | siptag_min_se |
Tag for Min-SE header object. | |
tag_typedef_t | siptag_min_se_str |
Tag for string with Min-SE header value. | |
msg_hclass_t | sip_min_se_class [] |
Header class for SIP Min-SE header. |
#define SIP_MIN_SE_INIT | ( | ) |
Initializer for structure sip_min_se_t.
A static sip_min_se_t structure must be initialized. The SIP_MIN_SE_INIT() macro provides initialization value. For instance,
#define SIPTAG_MIN_SE | ( | x | ) |
Tag list item for pointer to a Min-SE header structure.
The SIPTAG_MIN_SE() macro is used to include a tag item with a pointer to a sip_min_se_t object in a tag list.
x | pointer to a sip_min_se_t header structure, or NULL. |
#define SIPTAG_MIN_SE_STR | ( | s | ) |
Tag list item for string with Min-SE header value.
The SIPTAG_MIN_SE_STR() macro is used to include a tag item with a string containing value of a sip_min_se_t header in a tag list.
s | pointer to a string containing sip_min_se_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_MIN_SE_STR_REF().
sip_min_se_hash |
@
Hash of Min-SE header.
int sip_is_min_se | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_min_se_t.
The function sip_is_min_se() returns true (nonzero) if the header class is an instance of Min-SE header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_min_se_t * sip_min_se_copy | ( | su_home_t * | home, | |
sip_min_se_t const * | hdr | |||
) | [inline] |
Copy a sip_min_se_t header structure.
The function sip_min_se_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_se = sip_min_se_copy(home, sip->sip_min_se);
sip_min_se_t * sip_min_se_dup | ( | su_home_t * | home, | |
sip_min_se_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_min_se_t
.
The function sip_min_se_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_se = sip_min_se_dup(home, sip->sip_min_se);
sip_min_se_t * sip_min_se_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Min-SE header from formatting result.
The function sip_min_se_format() makes a new Min-SE 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_se_t* sip_min_se_init | ( | sip_min_se_t | x[1] | ) | [inline] |
Initialize a structure sip_min_se_t.
An sip_min_se_t structure can be initialized with the sip_min_se_init() function/macro. For instance,
sip_min_se_t * sip_min_se_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_min_se_t.
The function sip_min_se_make() makes a new sip_min_se_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-SE header.
The header class sip_min_se_class defines how a SIP Min-SE header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_min_se_t header structure.