Collaboration diagram for SIP-If-Match Header:
![]() |
Its syntax is defined in RFC 3903 as follows:
SIP-If-Match = "SIP-If-Match" HCOLON entity-tag
entity-tag = token
Defines | |
#define | sip_if_match(sip) |
Access a sip_if_match_t from sip_t. | |
#define | SIP_IF_MATCH_INIT() |
Initializer for structure sip_if_match_t. | |
#define | SIPTAG_IF_MATCH(x) |
Tag list item for pointer to a SIP-If-Match header structure. | |
#define | SIPTAG_IF_MATCH_REF(x) |
Tag list item for reference to a a SIP-If-Match header pointer. | |
#define | SIPTAG_IF_MATCH_STR(s) |
Tag list item for string with SIP-If-Match header value. | |
#define | SIPTAG_IF_MATCH_STR_REF(x) |
Tag list item for reference to a a SIP-If-Match header string. | |
Enumerator | |
sip_if_match_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_if_match_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a SIP-If-Match header. | |
SOFIAPUBFUN int | sip_if_match_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a SIP-If-Match header. | |
sip_if_match_t * | sip_if_match_init (sip_if_match_t x[1]) |
Initialize a structure sip_if_match_t. | |
int | sip_is_if_match (sip_header_t const *header) |
Test if header object is instance of sip_if_match_t. | |
sip_if_match_t * | sip_if_match_dup (su_home_t *home, sip_if_match_t const *hdr)) |
Duplicate (deep copy) sip_if_match_t . | |
sip_if_match_t * | sip_if_match_copy (su_home_t *home, sip_if_match_t const *hdr)) |
Copy a sip_if_match_t header structure. | |
sip_if_match_t * | sip_if_match_make (su_home_t *home, char const *s)) |
Make a header structure sip_if_match_t. | |
sip_if_match_t * | sip_if_match_format (su_home_t *home, char const *fmt,...))) |
Make a SIP-If-Match header from formatting result. | |
Variables | |
tag_typedef_t | siptag_if_match |
Tag for SIP-If-Match header object. | |
tag_typedef_t | siptag_if_match_str |
Tag for string with SIP-If-Match header value. | |
msg_hclass_t | sip_if_match_class [] |
Header class for SIP SIP-If-Match header. |
#define SIP_IF_MATCH_INIT | ( | ) |
Initializer for structure sip_if_match_t.
A static sip_if_match_t structure must be initialized. The SIP_IF_MATCH_INIT() macro provides initialization value. For instance,
#define SIPTAG_IF_MATCH | ( | x | ) |
Tag list item for pointer to a SIP-If-Match header structure.
The SIPTAG_IF_MATCH() macro is used to include a tag item with a pointer to a sip_if_match_t object in a tag list.
x | pointer to a sip_if_match_t header structure, or NULL. |
#define SIPTAG_IF_MATCH_STR | ( | s | ) |
Tag list item for string with SIP-If-Match header value.
The SIPTAG_IF_MATCH_STR() macro is used to include a tag item with a string containing value of a sip_if_match_t header in a tag list.
s | pointer to a string containing sip_if_match_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_IF_MATCH_STR_REF().
sip_if_match_hash |
@
Hash of SIP-If-Match header.
sip_if_match_t * sip_if_match_copy | ( | su_home_t * | home, | |
sip_if_match_t const * | hdr | |||
) | [inline] |
Copy a sip_if_match_t header structure.
The function sip_if_match_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 |
if_match = sip_if_match_copy(home, sip->sip_if_match);
sip_if_match_t * sip_if_match_dup | ( | su_home_t * | home, | |
sip_if_match_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_if_match_t
.
The function sip_if_match_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 |
if_match = sip_if_match_dup(home, sip->sip_if_match);
sip_if_match_t * sip_if_match_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a SIP-If-Match header from formatting result.
The function sip_if_match_format() makes a new SIP-If-Match 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_if_match_t* sip_if_match_init | ( | sip_if_match_t | x[1] | ) | [inline] |
Initialize a structure sip_if_match_t.
An sip_if_match_t structure can be initialized with the sip_if_match_init() function/macro. For instance,
sip_if_match_t * sip_if_match_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_if_match_t.
The function sip_if_match_make() makes a new sip_if_match_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_if_match | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_if_match_t.
The function sip_is_if_match() returns true (nonzero) if the header class is an instance of SIP-If-Match header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP SIP-If-Match header.
The header class sip_if_match_class defines how a SIP SIP-If-Match header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_if_match_t header structure.