Collaboration diagram for Separator Line:
![]() |
In order to avoid modifying messages with integrity protection, the separator line has its own header structure which is included in the sip_t structure.
Defines | |
#define | sip_separator(sip) |
Access a sip_separator_t from sip_t. | |
#define | SIP_SEPARATOR_INIT() |
Initializer for structure sip_separator_t. | |
#define | SIPTAG_SEPARATOR(x) |
Tag list item for pointer to a separator line between headers and payload structure. | |
#define | SIPTAG_SEPARATOR_REF(x) |
Tag list item for reference to a a separator line between headers and payload pointer. | |
#define | SIPTAG_SEPARATOR_STR(s) |
Tag list item for string with separator line between headers and payload value. | |
#define | SIPTAG_SEPARATOR_STR_REF(x) |
Tag list item for reference to a a separator line between headers and payload string. | |
Typedefs | |
typedef msg_separator_t | sip_separator_t |
Separator line between payload and headers. | |
Enumerator | |
sip_separator_hash | |
@ | |
Functions | |
sip_separator_t * | sip_separator_create (su_home_t *home) |
Create a SIP separator line structure. | |
SOFIAPUBFUN int | sip_separator_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a separator line between headers and payload. | |
SOFIAPUBFUN int | sip_separator_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a separator line between headers and payload. | |
sip_separator_t * | sip_separator_init (sip_separator_t x[1]) |
Initialize a structure sip_separator_t. | |
int | sip_is_separator (sip_header_t const *header) |
Test if header object is instance of sip_separator_t. | |
sip_separator_t * | sip_separator_dup (su_home_t *home, sip_separator_t const *hdr)) |
Duplicate (deep copy) sip_separator_t . | |
sip_separator_t * | sip_separator_copy (su_home_t *home, sip_separator_t const *hdr)) |
Copy a sip_separator_t header structure. | |
sip_separator_t * | sip_separator_make (su_home_t *home, char const *s)) |
Make a header structure sip_separator_t. | |
sip_separator_t * | sip_separator_format (su_home_t *home, char const *fmt,...))) |
Make a separator line between headers and payload from formatting result. | |
Variables | |
tag_typedef_t | siptag_separator |
Tag for separator line between headers and payload object. | |
tag_typedef_t | siptag_separator_str |
Tag for string with separator line between headers and payload value. | |
msg_hclass_t | sip_separator_class [] |
Header class for SIP separator line between headers and payload. |
#define SIP_SEPARATOR_INIT | ( | ) |
Initializer for structure sip_separator_t.
A static sip_separator_t structure must be initialized. The SIP_SEPARATOR_INIT() macro provides initialization value. For instance,
#define SIPTAG_SEPARATOR | ( | x | ) |
Tag list item for pointer to a separator line between headers and payload structure.
The SIPTAG_SEPARATOR() macro is used to include a tag item with a pointer to a sip_separator_t object in a tag list.
x | pointer to a sip_separator_t header structure, or NULL. |
#define SIPTAG_SEPARATOR_STR | ( | s | ) |
Tag list item for string with separator line between headers and payload value.
The SIPTAG_SEPARATOR_STR() macro is used to include a tag item with a string containing value of a sip_separator_t header in a tag list.
s | pointer to a string containing sip_separator_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SEPARATOR_STR_REF().
typedef struct sip_separator_s sip_separator_t |
Separator line between payload and headers.
The sip_separator_t is defined as follows:
typedef struct sip_separator_s { msg_common_t sep_common[1]; // Common fragment info msg_header_t *sep_next; // Pointer to next header char sep_data[4]; // NUL-terminated separator } sip_separator_t;
sip_separator_hash |
@
Hash of separator line between headers and payload.
int sip_is_separator | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_separator_t.
The function sip_is_separator() returns true (nonzero) if the header class is an instance of separator line between headers and payload object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_separator_t * sip_separator_copy | ( | su_home_t * | home, | |
sip_separator_t const * | hdr | |||
) | [inline] |
Copy a sip_separator_t header structure.
The function sip_separator_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 |
separator = sip_separator_copy(home, sip->sip_separator);
sip_separator_t * sip_separator_dup | ( | su_home_t * | home, | |
sip_separator_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_separator_t
.
The function sip_separator_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 |
separator = sip_separator_dup(home, sip->sip_separator);
sip_separator_t * sip_separator_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a separator line between headers and payload from formatting result.
The function sip_separator_format() makes a new separator line between headers and payload 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_separator_t* sip_separator_init | ( | sip_separator_t | x[1] | ) | [inline] |
Initialize a structure sip_separator_t.
An sip_separator_t structure can be initialized with the sip_separator_init() function/macro. For instance,
sip_separator_t * sip_separator_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_separator_t.
The function sip_separator_make() makes a new sip_separator_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 separator line between headers and payload.
The header class sip_separator_class defines how a SIP separator line between headers and payload is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_separator_t header structure.