Collaboration diagram for Unknown Headers:
![]() |
The whole unknown header including its name is included in the header value string g_value.
Defines | |
#define | sip_unknown(sip) |
Access a sip_unknown_t from sip_t. | |
#define | SIP_UNKNOWN_INIT() |
Initializer for structure sip_unknown_t. | |
#define | SIPTAG_UNKNOWN(x) |
Tag list item for pointer to a unknown headers structure. | |
#define | SIPTAG_UNKNOWN_REF(x) |
Tag list item for reference to a a unknown headers pointer. | |
#define | SIPTAG_UNKNOWN_STR(s) |
Tag list item for string with unknown headers value. | |
#define | SIPTAG_UNKNOWN_STR_REF(x) |
Tag list item for reference to a a unknown headers string. | |
Enumerator | |
sip_unknown_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_unknown_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a unknown headers. | |
SOFIAPUBFUN int | sip_unknown_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a unknown headers. | |
sip_unknown_t * | sip_unknown_init (sip_unknown_t x[1]) |
Initialize a structure sip_unknown_t. | |
int | sip_is_unknown (sip_header_t const *header) |
Test if header object is instance of sip_unknown_t. | |
sip_unknown_t * | sip_unknown_dup (su_home_t *home, sip_unknown_t const *hdr)) |
Duplicate (deep copy) sip_unknown_t . | |
sip_unknown_t * | sip_unknown_copy (su_home_t *home, sip_unknown_t const *hdr)) |
Copy a sip_unknown_t header structure. | |
sip_unknown_t * | sip_unknown_make (su_home_t *home, char const *s)) |
Make a header structure sip_unknown_t. | |
sip_unknown_t * | sip_unknown_format (su_home_t *home, char const *fmt,...))) |
Make a unknown headers from formatting result. | |
Variables | |
tag_typedef_t | siptag_unknown |
Tag for unknown headers object. | |
tag_typedef_t | siptag_unknown_str |
Tag for string with unknown headers value. | |
msg_hclass_t | sip_unknown_class [] |
Header class for SIP unknown headers. |
#define SIP_UNKNOWN_INIT | ( | ) |
Initializer for structure sip_unknown_t.
A static sip_unknown_t structure must be initialized. The SIP_UNKNOWN_INIT() macro provides initialization value. For instance,
#define SIPTAG_UNKNOWN | ( | x | ) |
Tag list item for pointer to a unknown headers structure.
The SIPTAG_UNKNOWN() macro is used to include a tag item with a pointer to a sip_unknown_t object in a tag list.
x | pointer to a sip_unknown_t header structure, or NULL. |
#define SIPTAG_UNKNOWN_STR | ( | s | ) |
Tag list item for string with unknown headers value.
The SIPTAG_UNKNOWN_STR() macro is used to include a tag item with a string containing value of a sip_unknown_t header in a tag list.
s | pointer to a string containing sip_unknown_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_UNKNOWN_STR_REF().
sip_unknown_hash |
@
Hash of unknown headers.
int sip_is_unknown | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_unknown_t.
The function sip_is_unknown() returns true (nonzero) if the header class is an instance of unknown headers object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_unknown_t * sip_unknown_copy | ( | su_home_t * | home, | |
sip_unknown_t const * | hdr | |||
) | [inline] |
Copy a sip_unknown_t header structure.
The function sip_unknown_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 |
unknown = sip_unknown_copy(home, sip->sip_unknown);
sip_unknown_t * sip_unknown_dup | ( | su_home_t * | home, | |
sip_unknown_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_unknown_t
.
The function sip_unknown_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 |
unknown = sip_unknown_dup(home, sip->sip_unknown);
sip_unknown_t * sip_unknown_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a unknown headers from formatting result.
The function sip_unknown_format() makes a new unknown headers 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_unknown_t* sip_unknown_init | ( | sip_unknown_t | x[1] | ) | [inline] |
Initialize a structure sip_unknown_t.
An sip_unknown_t structure can be initialized with the sip_unknown_init() function/macro. For instance,
sip_unknown_t * sip_unknown_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_unknown_t.
The function sip_unknown_make() makes a new sip_unknown_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 unknown headers.
The header class sip_unknown_class defines how a SIP unknown headers is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_unknown_t header structure.