An empty line separates headers from the message body.
More...
|
msg_parse_f | msg_separator_d |
| Parse a separator line between headers and body.
|
|
msg_print_f | msg_separator_e |
| Print a separator line between headers and body.
|
|
msg_hclass_t | msg_separator_class [] |
| Header class for separator line between headers and body.
|
|
An empty line separates headers from the message body.
In order to avoid modifying messages with integrity protection, the separator line has its own header structure which is included in the msg_t structure.
◆ MSG_SEPARATOR_INIT
#define MSG_SEPARATOR_INIT |
( |
| ) |
|
Initializer for structure msg_separator_t.
A static msg_separator_t structure must be initialized with the MSG_SEPARATOR_INIT() macro. For instance,
#define MSG_SEPARATOR_INIT()
Initializer for structure msg_separator_t.
Definition msg_protos.h:589
Separator.
Definition msg_types.h:207
◆ anonymous enum
Enumerator |
---|
msg_separator_hash | Hash of separator line between headers and body.
|
◆ msg_is_separator()
Test if header object is instance of msg_separator_t.
The function msg_is_separator() returns true (nonzero) if the header class is an instance of separator line between headers and body object and false (zero) otherwise.
- Parameters
-
header | pointer to the header structure to be tested |
- Returns
- The function msg_is_separator() returns true (nonzero) if the header object is an instance of header separator and false (zero) otherwise.
◆ msg_separator_copy()
Copy a msg_separator_t header structure.
The function msg_separator_copy() copies a header structure header. If the header structure header contains a reference (header->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 header.
- Parameters
-
home | memory home used to allocate new structure |
header | pointer to the header structure to be duplicated |
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 header, including the encoding of the old header, if present.
- Example
msg_separator_t * msg_separator_copy(su_home_t *home, msg_separator_t const *header))
Copy a msg_separator_t header structure.
Definition msg_protos.h:720
- Returns
- The function msg_separator_copy() returns a pointer to newly copied header structure, or NULL upon an error.
◆ msg_separator_dup()
Duplicate (deep copy) msg_separator_t
.
The function msg_separator_dup() duplicates a header structure header. If the header structure header contains a reference (header->x_next
) to a list of headers, all the headers in the list are duplicated, too.
- Parameters
-
home | memory home used to allocate new structure |
header | 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.
- Example
msg_separator_t * msg_separator_dup(su_home_t *home, msg_separator_t const *header))
Duplicate (deep copy) msg_separator_t.
Definition msg_protos.h:674
- Returns
- The function msg_separator_dup() returns a pointer to the newly duplicated msg_separator_t header structure, or NULL upon an error.
◆ msg_separator_format()
Make a separator line between headers and body from formatting result.
The function msg_separator_format() makes a new separator line between headers and body 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.
- Parameters
-
home | memory home used to allocate new header structure. |
fmt | string used as a printf()-style format |
... | argument list for format |
- Note
- This function is usually implemented as a macro calling msg_header_format().
- Returns
- The function msg_separator_format() returns a pointer to newly makes header structure, or NULL upon an error.
◆ msg_separator_init()
Initialize a structure msg_separator_t.
An msg_separator_t structure can be initialized with the msg_separator_init() function/macro. For instance,
msg_separator_t * msg_separator_init(msg_separator_t x[1])
Initialize a structure msg_separator_t.
Definition msg_protos.h:606
- Parameters
-
x | pointer to msg_separator_t structure |
◆ msg_separator_make()
Make a header structure msg_separator_t.
The function msg_separator_make() makes a new msg_separator_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
- Parameters
-
home | memory home used to allocate new header structure. |
s | string to be decoded as value of the new header structure |
- Note
- This function is usually implemented as a macro calling msg_header_make().
- Returns
- The function msg_separator_make() returns a pointer to newly maked msg_separator_t header structure, or NULL upon an error.
◆ msg_separator_class
Header class for separator line between headers and body.
The header class msg_separator_class defines how a separator line between headers and body header is parsed and printed. It also contains methods used by message parser and other functions to manipulate the msg_separator_t header structure.