Allow header.

Defines
#define	HTTP_ALLOW_INIT()
	Initializer for structure http_allow_t.
#define	HTTPTAG_ALLOW(x)
	Tag list item for pointer to a Allow header object.
#define	HTTPTAG_ALLOW_STR(s)
	Tag list item for string with Allow header value.
Enumerations
enum	{ http_allow_hash }
Functions
http_allow_t *	http_allow_init (http_allow_t x[1])
	Initialize a structure http_allow_t.
int	http_is_allow (http_header_t const *header)
	Test if header object is instance of http_allow_t.
http_allow_t *	http_allow_dup (su_home_t *home, http_allow_t const *hdr))
	Duplicate (deep copy) http_allow_t.
http_allow_t *	http_allow_copy (su_home_t *home, http_allow_t const *hdr))
	Copy a http_allow_t header structure.
http_allow_t *	http_allow_make (su_home_t *home, char const *s))
	Make a header structure http_allow_t.
http_allow_t *	http_allow_format (su_home_t *home, char const *fmt,...)))
	Make a Allow header from formatting result.
Variables
msg_hclass_t	http_allow_class []
	Header class for HTTP Allow header.
msg_parse_f	http_allow_d
	Decode (parse) a Allow header.
msg_print_f	http_allow_e
	Encode (print) a Allow header.

---

Define Documentation

#define HTTP_ALLOW_INIT

(

)

Initializer for structure http_allow_t.

A static http_allow_t structure must be initialized with the HTTP_ALLOW_INIT() macro. For instance,

  http_allow_t http_allow = HTTP_ALLOW_INIT;

#define HTTPTAG_ALLOW

(

x

)

Tag list item for pointer to a Allow header object.

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

Parameters:

x

pointer to a http_allow_t header structure, or NULL.

#define HTTPTAG_ALLOW_STR

(

s

)

Tag list item for string with Allow header value.

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

Parameters:

s

pointer to a string containing http_allow_t value, or NULL.

The HTTPTAG_ALLOW_STR string can be converted to a http_allow_t header structure by giving the string s has second argument to function http_allow_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_allow_hash

Hash of Allow header.

---

Function Documentation

http_allow_t * http_allow_copy	(	su_home_t *	home,
		http_allow_t const *	hdr
	)			[inline]

Copy a http_allow_t header structure.

The function http_allow_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

   allow = http_allow_copy(home, http->http_allow);

Returns:

The function http_allow_copy() returns a pointer to newly copied header structure, or NULL upon an error.

http_allow_t * http_allow_dup	(	su_home_t *	home,
		http_allow_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_allow_t.

The function http_allow_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

   allow = http_allow_dup(home, http->http_allow);

Returns:

The function http_allow_dup() returns a pointer to the newly duplicated http_allow_t header structure, or NULL upon an error.

http_allow_t * http_allow_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Allow header from formatting result.

The function http_allow_format() makes a new Allow 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_allow_format() returns a pointer to newly makes header structure, or NULL upon an error.

http_allow_t* http_allow_init

(

http_allow_t

x[1]

)

[inline]

Initialize a structure http_allow_t.

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

  http_allow_t http_allow;

  http_allow_init(&http_allow);

http_allow_t * http_allow_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_allow_t.

The function http_allow_make() makes a new http_allow_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_allow_make() returns a pointer to newly maked http_allow_t header structure, or NULL upon an error.

int http_is_allow

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_allow_t.

The function http_is_allow() returns true (nonzero) if the header class is an instance of Allow header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

The function http_is_xallow() returns true (nonzero) if the header object is an instance of header allow and false (zero) otherwise.

---

Variable Documentation

msg_hclass_t http_allow_class[]

Header class for HTTP Allow header.

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