Collaboration diagram for SIP-ETag Header:
![]() |
Its syntax is defined in RFC 3903 as follows:
SIP-ETag = "SIP-ETag" HCOLON entity-tag
entity-tag = token
Defines | |
#define | sip_etag(sip) |
Access a sip_etag_t from sip_t. | |
#define | SIP_ETAG_INIT() |
Initializer for structure sip_etag_t. | |
#define | SIPTAG_ETAG(x) |
Tag list item for pointer to a SIP-ETag header structure. | |
#define | SIPTAG_ETAG_REF(x) |
Tag list item for reference to a a SIP-ETag header pointer. | |
#define | SIPTAG_ETAG_STR(s) |
Tag list item for string with SIP-ETag header value. | |
#define | SIPTAG_ETAG_STR_REF(x) |
Tag list item for reference to a a SIP-ETag header string. | |
Enumerator | |
sip_etag_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_etag_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a SIP-ETag header. | |
SOFIAPUBFUN int | sip_etag_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a SIP-ETag header. | |
sip_etag_t * | sip_etag_init (sip_etag_t x[1]) |
Initialize a structure sip_etag_t. | |
int | sip_is_etag (sip_header_t const *header) |
Test if header object is instance of sip_etag_t. | |
sip_etag_t * | sip_etag_dup (su_home_t *home, sip_etag_t const *hdr)) |
Duplicate (deep copy) sip_etag_t . | |
sip_etag_t * | sip_etag_copy (su_home_t *home, sip_etag_t const *hdr)) |
Copy a sip_etag_t header structure. | |
sip_etag_t * | sip_etag_make (su_home_t *home, char const *s)) |
Make a header structure sip_etag_t. | |
sip_etag_t * | sip_etag_format (su_home_t *home, char const *fmt,...))) |
Make a SIP-ETag header from formatting result. | |
Variables | |
tag_typedef_t | siptag_etag |
Tag for SIP-ETag header object. | |
tag_typedef_t | siptag_etag_str |
Tag for string with SIP-ETag header value. | |
msg_hclass_t | sip_etag_class [] |
Header class for SIP SIP-ETag header. |
#define SIP_ETAG_INIT | ( | ) |
Initializer for structure sip_etag_t.
A static sip_etag_t structure must be initialized. The SIP_ETAG_INIT() macro provides initialization value. For instance,
#define SIPTAG_ETAG | ( | x | ) |
Tag list item for pointer to a SIP-ETag header structure.
The SIPTAG_ETAG() macro is used to include a tag item with a pointer to a sip_etag_t object in a tag list.
x | pointer to a sip_etag_t header structure, or NULL. |
#define SIPTAG_ETAG_STR | ( | s | ) |
Tag list item for string with SIP-ETag header value.
The SIPTAG_ETAG_STR() macro is used to include a tag item with a string containing value of a sip_etag_t header in a tag list.
s | pointer to a string containing sip_etag_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_ETAG_STR_REF().
sip_etag_hash |
@
Hash of SIP-ETag header.
sip_etag_t * sip_etag_copy | ( | su_home_t * | home, | |
sip_etag_t const * | hdr | |||
) | [inline] |
Copy a sip_etag_t header structure.
The function sip_etag_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 |
etag = sip_etag_copy(home, sip->sip_etag);
sip_etag_t * sip_etag_dup | ( | su_home_t * | home, | |
sip_etag_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_etag_t
.
The function sip_etag_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 |
etag = sip_etag_dup(home, sip->sip_etag);
sip_etag_t * sip_etag_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a SIP-ETag header from formatting result.
The function sip_etag_format() makes a new SIP-ETag 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_etag_t* sip_etag_init | ( | sip_etag_t | x[1] | ) | [inline] |
Initialize a structure sip_etag_t.
An sip_etag_t structure can be initialized with the sip_etag_init() function/macro. For instance,
sip_etag_t * sip_etag_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_etag_t.
The function sip_etag_make() makes a new sip_etag_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_etag | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_etag_t.
The function sip_is_etag() returns true (nonzero) if the header class is an instance of SIP-ETag header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP SIP-ETag header.
The header class sip_etag_class defines how a SIP SIP-ETag header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_etag_t header structure.