Defines | Enumerations | Functions | Variables

Accept header.

We use MIME Accept header. More...

Defines

#define HTTP_ACCEPT_INIT()
 Initializer for structure http_accept_t.
#define HTTPTAG_ACCEPT(x)
 Tag list item for pointer to a Accept header object.
#define HTTPTAG_ACCEPT_STR(s)
 Tag list item for string with Accept header value.

Enumerations

enum  { http_accept_hash }

Functions

http_accept_thttp_accept_init (http_accept_t x[1])
 Initialize a structure http_accept_t.
int http_is_accept (http_header_t const *header)
 Test if header object is instance of http_accept_t.
http_accept_thttp_accept_dup (su_home_t *home, http_accept_t const *hdr))
 Duplicate (deep copy) http_accept_t.
http_accept_thttp_accept_copy (su_home_t *home, http_accept_t const *hdr))
 Copy a http_accept_t header structure.
http_accept_thttp_accept_make (su_home_t *home, char const *s))
 Make a header structure http_accept_t.
http_accept_thttp_accept_format (su_home_t *home, char const *fmt,...)))
 Make a Accept header from formatting result.

Variables

msg_hclass_t http_accept_class []
 Header class for HTTP Accept header.
msg_parse_f http_accept_d
 Decode (parse) a Accept header.
msg_print_f http_accept_e
 Encode (print) a Accept header.

Detailed Description

We use MIME Accept header.


Define Documentation

#define HTTP_ACCEPT_INIT (  ) 

Initializer for structure http_accept_t.

A static http_accept_t structure must be initialized with the HTTP_ACCEPT_INIT() macro. For instance,

  http_accept_t http_accept = HTTP_ACCEPT_INIT;
#define HTTPTAG_ACCEPT (   x  ) 

Tag list item for pointer to a Accept header object.

The HTTPTAG_ACCEPT() macro is used to include a tag item with a pointer to a http_accept_t object in a tag list.

Parameters:
x pointer to a http_accept_t header structure, or NULL.
#define HTTPTAG_ACCEPT_STR (   s  ) 

Tag list item for string with Accept header value.

The HTTPTAG_ACCEPT_STR() macro is used to include a tag item with a string containing value of a http_accept_t header in a tag list.

Parameters:
s pointer to a string containing http_accept_t value, or NULL.

The HTTPTAG_ACCEPT_STR string can be converted to a http_accept_t header structure by giving the string s has second argument to function http_accept_make().


Enumeration Type Documentation

anonymous enum
Enumerator:
http_accept_hash 

Hash of Accept header.


Function Documentation

http_accept_t * http_accept_copy ( su_home_t home,
http_accept_t const *  hdr 
) [inline]

Copy a http_accept_t header structure.

The function http_accept_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.

Parameters:
home memory home used to allocate new structure
hdr 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
   accept = http_accept_copy(home, http->http_accept);
Returns:
The function http_accept_copy() returns a pointer to newly copied header structure, or NULL upon an error.
http_accept_t * http_accept_dup ( su_home_t home,
http_accept_t const *  hdr 
) [inline]

Duplicate (deep copy) http_accept_t.

The function http_accept_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.

Parameters:
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.

Example
   accept = http_accept_dup(home, http->http_accept);
Returns:
The function http_accept_dup() returns a pointer to the newly duplicated http_accept_t header structure, or NULL upon an error.
http_accept_t * http_accept_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Accept header from formatting result.

The function http_accept_format() makes a new Accept header 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 http_accept_format() returns a pointer to newly makes header structure, or NULL upon an error.
http_accept_t* http_accept_init ( http_accept_t  x[1]  )  [inline]

Initialize a structure http_accept_t.

An http_accept_t structure can be initialized with the http_accept_init() function/macro. For instance,

  http_accept_t http_accept;

  http_accept_init(&http_accept);
http_accept_t * http_accept_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure http_accept_t.

The function http_accept_make() makes a new http_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 is usually implemented as a macro calling http_header_make().
Returns:
The function http_accept_make() returns a pointer to newly maked http_accept_t header structure, or NULL upon an error.
int http_is_accept ( http_header_t const *  header  )  [inline]

Test if header object is instance of http_accept_t.

The function http_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 http_is_xaccept() returns true (nonzero) if the header object is an instance of header accept and false (zero) otherwise.

Variable Documentation

Header class for HTTP Accept header.

The header class http_accept_class defines how a HTTP Accept header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_accept_t header structure.

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Sofia-SIP 1.12.11 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.