The Accept request-header field can be used to specify certain media types which are acceptable for the response.
More...
|
msg_parse_f | msg_accept_d |
| Parse a Accept header.
|
|
msg_print_f | msg_accept_e |
| Print a Accept header.
|
|
msg_hclass_t | msg_accept_class [] |
| Header class for Accept header.
|
|
The Accept request-header field can be used to specify certain media types which are acceptable for the response.
Its syntax is defined in [H14.1, S20.1] as follows:
Accept = "Accept" ":" #( media-range [ accept-params ] )
media-range = ( "*" "/" "*"
| ( type "/" "*" )
| ( type "/" subtype ) ) *( ";" parameter )
accept-params = ";" "q" "=" qvalue *( accept-extension )
accept-extension = ";" token [ "=" ( token | quoted-string ) ]
◆ MSG_ACCEPT_INIT
#define MSG_ACCEPT_INIT |
( |
| ) |
|
Initializer for an msg_accept_t structure.
A static msg_accept_t structure must be initialized with the MSG_ACCEPT_INIT() macro. For instance,
#define MSG_ACCEPT_INIT()
Initializer for an msg_accept_t structure.
Definition msg_mime_protos.h:1852
Structure for Accept header.
Definition msg_mime.h:80
◆ anonymous enum
Enumerator |
---|
msg_accept_hash | Hash of Accept header.
|
◆ msg_accept_copy()
Copy an msg_accept_t header structure.
The function msg_accept_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_accept_t * msg_accept_copy(su_home_t *home, msg_accept_t const *header)
Copy an msg_accept_t header structure.
Definition msg_mime_protos.h:1981
- Returns
- The function msg_accept_copy() returns a pointer to newly copied header structure, or NULL upon an error.
◆ msg_accept_dup()
Duplicate (deep copy) msg_accept_t.
The function msg_accept_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_accept_t * msg_accept_dup(su_home_t *home, msg_accept_t const *header)
Duplicate (deep copy) msg_accept_t.
Definition msg_mime_protos.h:1936
- Returns
- The function msg_accept_dup() returns a pointer to the newly duplicated msg_accept_t header structure, or NULL upon an error.
◆ msg_accept_format()
Make a Accept header from formatting result.
The function msg_accept_format() makes a new Accept header object using snprintf-formatted 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 may be implemented as a macro calling msg_header_format().
- Returns
- The function msg_accept_format() returns a pointer to newly makes header structure, or NULL upon an error.
◆ msg_accept_init()
Initialize an msg_accept_t structure.
An msg_accept_t structure can be initialized with the msg_accept_init() function/macro. For instance,
msg_accept_t * msg_accept_init(msg_accept_t x[1])
Initialize an msg_accept_t structure.
Definition msg_mime_protos.h:1869
- Parameters
-
x | pointer to msg_accept_t structure |
◆ msg_accept_make()
Make a header structure msg_accept_t.
The function msg_accept_make() makes a new msg_accept_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 may be implemented as a macro calling msg_header_make().
- Returns
- The function msg_accept_make() returns a pointer to newly maked msg_accept_t header structure, or NULL upon an error.
◆ msg_is_accept()
Test if header object is an instance of msg_accept_t.
The function msg_is_accept() returns true (nonzero) if the header class is an instance of Accept header object and false (zero) otherwise.
- Parameters
-
header | pointer to the header structure to be tested |
- Returns
- The function msg_is_accept() returns true (nonzero) if the header object is an instance of header Accept header and false (zero) otherwise.
◆ msg_accept_class
Header class for Accept header.
The header class msg_accept_class defines how a Accept header header is parsed and printed. It also contains methods used by message parser and other functions to manipulate the msg_accept_t header structure.