The Suppress-Body-If-Match header field identifies a SIP event content already known by the watcher. More...
The Suppress-Body-If-Match header field identifies a SIP event content already known by the watcher.
Its syntax is defined in draft-niemi-sip-subnot-etags-01 as follows:
Suppress-Body-If-Match = "Suppress-Body-If-Match" HCOLON entity-tag
entity-tag = token
The parsed Suppress-Body-If-Match header is stored in sip_suppress_body_if_match_t structure.
| #define sip_suppress_body_if_match | ( | sip | ) |
Access a SIP Suppress-Body-If-Match header structure sip_suppress_body_if_match_t from sip_t.
| #define SIP_SUPPRESS_BODY_IF_MATCH_INIT | ( | ) |
Initializer for structure sip_suppress_body_if_match_t.
A static sip_suppress_body_if_match_t structure for Suppress-Body-If-Match header must be initialized with the SIP_SUPPRESS_BODY_IF_MATCH_INIT() macro. For instance,
sip_suppress_body_if_match_t sip_suppress_body_if_match = SIP_SUPPRESS_BODY_IF_MATCH_INIT;
| #define SIPTAG_SUPPRESS_BODY_IF_MATCH | ( | x | ) |
Tag list item for pointer to a Suppress-Body-If-Match header structure sip_suppress_body_if_match_t.
The SIPTAG_SUPPRESS_BODY_IF_MATCH() macro is used to include a tag item with a pointer to a sip_suppress_body_if_match_t structure in a tag list.
| x | pointer to a sip_suppress_body_if_match_t structure, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SUPPRESS_BODY_IF_MATCH_REF().
| #define SIPTAG_SUPPRESS_BODY_IF_MATCH_STR | ( | s | ) |
Tag list item for string with Suppress-Body-If-Match header value.
The SIPTAG_SUPPRESS_BODY_IF_MATCH_STR() macro is used to include a tag item with a string containing value of a sip_suppress_body_if_match_t header in a tag list.
| s | pointer to a string containing Suppress-Body-If-Match header value, or NULL. |
The string in SIPTAG_SUPPRESS_BODY_IF_MATCH_STR() can be converted to a sip_suppress_body_if_match_t header structure by giving the string s has second argument to function sip_suppress_body_if_match_make().
The corresponding tag taking reference parameter is SIPTAG_SUPPRESS_BODY_IF_MATCH_STR_REF().
The structure sip_suppress_body_if_match_t contains representation of a SIP Suppress-Body-If-Match header.
The sip_suppress_body_if_match_t is defined as follows:
typedef struct sip_suppress_body_if_match_s { sip_common_t sbim_common[1]; // Common fragment info sip_error_t *sbim_next; // Dummy link to next header char const *sbim_tag; // entity-tag } sip_suppress_body_if_match_t;
| int sip_is_suppress_body_if_match | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_suppress_body_if_match_t.
Check if the header class is an instance of Suppress-Body-If-Match 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 suppress_body_if_match | |
| 0 | (false) otherwise |
| sip_suppress_body_if_match_t * sip_suppress_body_if_match_copy | ( | su_home_t * | home, | |
| sip_suppress_body_if_match_t const * | hdr | |||
| ) | [inline] |
Copy a list of Suppress-Body-If-Match header header structures sip_suppress_body_if_match_t.
The function sip_suppress_body_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 list of header structure hdr.
| home | memory home used to allocate new structure | |
| hdr | pointer to the header structure to be copied |
When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old hdr header, including the encoding of the old header, if present.
suppress_body_if_match = sip_suppress_body_if_match_copy(home, sip->sip_suppress_body_if_match);
| sip_suppress_body_if_match_t * sip_suppress_body_if_match_dup | ( | su_home_t * | home, | |
| sip_suppress_body_if_match_t const * | hdr | |||
| ) | [inline] |
Duplicate a list of Suppress-Body-If-Match header header structures sip_suppress_body_if_match_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 |
When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.
suppress_body_if_match = sip_suppress_body_if_match_dup(home, sip->sip_suppress_body_if_match);
| sip_suppress_body_if_match_t * sip_suppress_body_if_match_format | ( | su_home_t * | home, | |
| char const * | fmt, | |||
| ... | ||||
| ) | [inline] |
Make a Suppress-Body-If-Match header from formatting result.
Make a new sip_suppress_body_if_match_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_suppress_body_if_match_t.
| home | memory home used to allocate new header structure. | |
| fmt | string used as a printf()-style format | |
| ... | argument list for format |
| sip_suppress_body_if_match_t* sip_suppress_body_if_match_init | ( | sip_suppress_body_if_match_t | x[1] | ) | [inline] |
Initialize a structure sip_suppress_body_if_match_t.
An sip_suppress_body_if_match_t structure for Suppress-Body-If-Match header can be initialized with the sip_suppress_body_if_match_init() function/macro. For instance,
sip_suppress_body_if_match_t sip_suppress_body_if_match; sip_suppress_body_if_match_init(&sip_suppress_body_if_match);
| sip_suppress_body_if_match_t * sip_suppress_body_if_match_make | ( | su_home_t * | home, | |
| char const * | s | |||
| ) | [inline] |
Make a Suppress-Body-If-Match header structure sip_suppress_body_if_match_t.
The function sip_suppress_body_if_match_make() makes a new sip_suppress_body_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 |
Header class for Suppress-Body-If-Match header.
The header class sip_suppress_body_if_match_class defines how a SIP Suppress-Body-If-Match header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_suppress_body_if_match_t header structure.