Trailer header.

Defines
#define	HTTP_TRAILER_INIT()
	Initializer for structure http_trailer_t.
#define	HTTPTAG_TRAILER(x)
	Tag list item for pointer to a Trailer header object.
#define	HTTPTAG_TRAILER_STR(s)
	Tag list item for string with Trailer header value.
Enumerations
enum	{ http_trailer_hash }
Functions
http_trailer_t *	http_trailer_init (http_trailer_t x[1])
	Initialize a structure http_trailer_t.
int	http_is_trailer (http_header_t const *header)
	Test if header object is instance of http_trailer_t.
http_trailer_t *	http_trailer_dup (su_home_t *home, http_trailer_t const *hdr))
	Duplicate (deep copy) http_trailer_t.
http_trailer_t *	http_trailer_copy (su_home_t *home, http_trailer_t const *hdr))
	Copy a http_trailer_t header structure.
http_trailer_t *	http_trailer_make (su_home_t *home, char const *s))
	Make a header structure http_trailer_t.
http_trailer_t *	http_trailer_format (su_home_t *home, char const *fmt,...)))
	Make a Trailer header from formatting result.
Variables
msg_hclass_t	http_trailer_class []
	Header class for HTTP Trailer header.
msg_parse_f	http_trailer_d
	Decode (parse) a Trailer header.
msg_print_f	http_trailer_e
	Encode (print) a Trailer header.

---

Define Documentation

#define HTTP_TRAILER_INIT

(

)

Initializer for structure http_trailer_t.

A static http_trailer_t structure must be initialized with the HTTP_TRAILER_INIT() macro. For instance,

  http_trailer_t http_trailer = HTTP_TRAILER_INIT;

#define HTTPTAG_TRAILER

(

x

)

Tag list item for pointer to a Trailer header object.

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

Parameters:

x

pointer to a http_trailer_t header structure, or NULL.

#define HTTPTAG_TRAILER_STR

(

s

)

Tag list item for string with Trailer header value.

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

Parameters:

s

pointer to a string containing http_trailer_t value, or NULL.

The HTTPTAG_TRAILER_STR string can be converted to a http_trailer_t header structure by giving the string s has second argument to function http_trailer_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_trailer_hash

Hash of Trailer header.

---

Function Documentation

int http_is_trailer

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_trailer_t.

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

Parameters:

header

pointer to the header structure to be tested

Returns:

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

http_trailer_t * http_trailer_copy	(	su_home_t *	home,
		http_trailer_t const *	hdr
	)			[inline]

Copy a http_trailer_t header structure.

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

   trailer = http_trailer_copy(home, http->http_trailer);

Returns:

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

http_trailer_t * http_trailer_dup	(	su_home_t *	home,
		http_trailer_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_trailer_t.

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

   trailer = http_trailer_dup(home, http->http_trailer);

Returns:

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

http_trailer_t * http_trailer_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Trailer header from formatting result.

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

http_trailer_t* http_trailer_init

(

http_trailer_t

x[1]

)

[inline]

Initialize a structure http_trailer_t.

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

  http_trailer_t http_trailer;

  http_trailer_init(&http_trailer);

http_trailer_t * http_trailer_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_trailer_t.

The function http_trailer_make() makes a new http_trailer_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_trailer_make() returns a pointer to newly maked http_trailer_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_trailer_class[]

Header class for HTTP Trailer header.

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