Pragma header.

Defines
#define	HTTP_PRAGMA_INIT()
	Initializer for structure http_pragma_t.
#define	HTTPTAG_PRAGMA(x)
	Tag list item for pointer to a Pragma header object.
#define	HTTPTAG_PRAGMA_STR(s)
	Tag list item for string with Pragma header value.
Enumerations
enum	{ http_pragma_hash }
Functions
http_pragma_t *	http_pragma_init (http_pragma_t x[1])
	Initialize a structure http_pragma_t.
int	http_is_pragma (http_header_t const *header)
	Test if header object is instance of http_pragma_t.
http_pragma_t *	http_pragma_dup (su_home_t *home, http_pragma_t const *hdr))
	Duplicate (deep copy) http_pragma_t.
http_pragma_t *	http_pragma_copy (su_home_t *home, http_pragma_t const *hdr))
	Copy a http_pragma_t header structure.
http_pragma_t *	http_pragma_make (su_home_t *home, char const *s))
	Make a header structure http_pragma_t.
http_pragma_t *	http_pragma_format (su_home_t *home, char const *fmt,...)))
	Make a Pragma header from formatting result.
Variables
msg_hclass_t	http_pragma_class []
	Header class for HTTP Pragma header.
msg_parse_f	http_pragma_d
	Decode (parse) a Pragma header.
msg_print_f	http_pragma_e
	Encode (print) a Pragma header.

---

Define Documentation

#define HTTP_PRAGMA_INIT

(

)

Initializer for structure http_pragma_t.

A static http_pragma_t structure must be initialized with the HTTP_PRAGMA_INIT() macro. For instance,

  http_pragma_t http_pragma = HTTP_PRAGMA_INIT;

#define HTTPTAG_PRAGMA

(

x

)

Tag list item for pointer to a Pragma header object.

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

Parameters:

x

pointer to a http_pragma_t header structure, or NULL.

#define HTTPTAG_PRAGMA_STR

(

s

)

Tag list item for string with Pragma header value.

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

Parameters:

s

pointer to a string containing http_pragma_t value, or NULL.

The HTTPTAG_PRAGMA_STR string can be converted to a http_pragma_t header structure by giving the string s has second argument to function http_pragma_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_pragma_hash

Hash of Pragma header.

---

Function Documentation

int http_is_pragma

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_pragma_t.

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

Parameters:

header

pointer to the header structure to be tested

Returns:

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

http_pragma_t * http_pragma_copy	(	su_home_t *	home,
		http_pragma_t const *	hdr
	)			[inline]

Copy a http_pragma_t header structure.

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

   pragma = http_pragma_copy(home, http->http_pragma);

Returns:

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

http_pragma_t * http_pragma_dup	(	su_home_t *	home,
		http_pragma_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_pragma_t.

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

   pragma = http_pragma_dup(home, http->http_pragma);

Returns:

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

http_pragma_t * http_pragma_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Pragma header from formatting result.

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

http_pragma_t* http_pragma_init

(

http_pragma_t

x[1]

)

[inline]

Initialize a structure http_pragma_t.

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

  http_pragma_t http_pragma;

  http_pragma_init(&http_pragma);

http_pragma_t * http_pragma_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_pragma_t.

The function http_pragma_make() makes a new http_pragma_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_pragma_make() returns a pointer to newly maked http_pragma_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_pragma_class[]

Header class for HTTP Pragma header.

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