Max-Forwards header.

Defines
#define	HTTP_MAX_FORWARDS_INIT()
	Initializer for structure http_max_forwards_t.
#define	HTTPTAG_MAX_FORWARDS(x)
	Tag list item for pointer to a Max-Forwards header object.
#define	HTTPTAG_MAX_FORWARDS_STR(s)
	Tag list item for string with Max-Forwards header value.
Enumerations
enum	{ http_max_forwards_hash }
Functions
http_max_forwards_t *	http_max_forwards_init (http_max_forwards_t x[1])
	Initialize a structure http_max_forwards_t.
int	http_is_max_forwards (http_header_t const *header)
	Test if header object is instance of http_max_forwards_t.
http_max_forwards_t *	http_max_forwards_dup (su_home_t *home, http_max_forwards_t const *hdr))
	Duplicate (deep copy) http_max_forwards_t.
http_max_forwards_t *	http_max_forwards_copy (su_home_t *home, http_max_forwards_t const *hdr))
	Copy a http_max_forwards_t header structure.
http_max_forwards_t *	http_max_forwards_make (su_home_t *home, char const *s))
	Make a header structure http_max_forwards_t.
http_max_forwards_t *	http_max_forwards_format (su_home_t *home, char const *fmt,...)))
	Make a Max-Forwards header from formatting result.
Variables
msg_hclass_t	http_max_forwards_class []
	Header class for HTTP Max-Forwards header.
msg_parse_f	http_max_forwards_d
	Decode (parse) a Max-Forwards header.
msg_print_f	http_max_forwards_e
	Encode (print) a Max-Forwards header.

---

Define Documentation

#define HTTP_MAX_FORWARDS_INIT

(

)

Initializer for structure http_max_forwards_t.

A static http_max_forwards_t structure must be initialized with the HTTP_MAX_FORWARDS_INIT() macro. For instance,

  http_max_forwards_t http_max_forwards = HTTP_MAX_FORWARDS_INIT;

#define HTTPTAG_MAX_FORWARDS

(

x

)

Tag list item for pointer to a Max-Forwards header object.

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

Parameters:

x

pointer to a http_max_forwards_t header structure, or NULL.

#define HTTPTAG_MAX_FORWARDS_STR

(

s

)

Tag list item for string with Max-Forwards header value.

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

Parameters:

s

pointer to a string containing http_max_forwards_t value, or NULL.

The HTTPTAG_MAX_FORWARDS_STR string can be converted to a http_max_forwards_t header structure by giving the string s has second argument to function http_max_forwards_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_max_forwards_hash

Hash of Max-Forwards header.

---

Function Documentation

int http_is_max_forwards

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_max_forwards_t.

The function http_is_max_forwards() returns true (nonzero) if the header class is an instance of Max-Forwards header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

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

http_max_forwards_t * http_max_forwards_copy	(	su_home_t *	home,
		http_max_forwards_t const *	hdr
	)			[inline]

Copy a http_max_forwards_t header structure.

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

   max_forwards = http_max_forwards_copy(home, http->http_max_forwards);

Returns:

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

http_max_forwards_t * http_max_forwards_dup	(	su_home_t *	home,
		http_max_forwards_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_max_forwards_t.

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

   max_forwards = http_max_forwards_dup(home, http->http_max_forwards);

Returns:

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

http_max_forwards_t * http_max_forwards_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Max-Forwards header from formatting result.

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

http_max_forwards_t* http_max_forwards_init

(

http_max_forwards_t

x[1]

)

[inline]

Initialize a structure http_max_forwards_t.

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

  http_max_forwards_t http_max_forwards;

  http_max_forwards_init(&http_max_forwards);

http_max_forwards_t * http_max_forwards_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_max_forwards_t.

The function http_max_forwards_make() makes a new http_max_forwards_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_max_forwards_make() returns a pointer to newly maked http_max_forwards_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_max_forwards_class[]

Header class for HTTP Max-Forwards header.

The header class http_max_forwards_class defines how a HTTP Max-Forwards header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_max_forwards_t header structure.