Cache-Control header.

Defines
#define	HTTP_CACHE_CONTROL_INIT()
	Initializer for structure http_cache_control_t.
#define	HTTPTAG_CACHE_CONTROL(x)
	Tag list item for pointer to a Cache-Control header object.
#define	HTTPTAG_CACHE_CONTROL_STR(s)
	Tag list item for string with Cache-Control header value.
Enumerations
enum	{ http_cache_control_hash }
Functions
http_cache_control_t *	http_cache_control_init (http_cache_control_t x[1])
	Initialize a structure http_cache_control_t.
int	http_is_cache_control (http_header_t const *header)
	Test if header object is instance of http_cache_control_t.
http_cache_control_t *	http_cache_control_dup (su_home_t *home, http_cache_control_t const *hdr))
	Duplicate (deep copy) http_cache_control_t.
http_cache_control_t *	http_cache_control_copy (su_home_t *home, http_cache_control_t const *hdr))
	Copy a http_cache_control_t header structure.
http_cache_control_t *	http_cache_control_make (su_home_t *home, char const *s))
	Make a header structure http_cache_control_t.
http_cache_control_t *	http_cache_control_format (su_home_t *home, char const *fmt,...)))
	Make a Cache-Control header from formatting result.
Variables
msg_hclass_t	http_cache_control_class []
	Header class for HTTP Cache-Control header.
msg_parse_f	http_cache_control_d
	Decode (parse) a Cache-Control header.
msg_print_f	http_cache_control_e
	Encode (print) a Cache-Control header.

---

Define Documentation

#define HTTP_CACHE_CONTROL_INIT

(

)

Initializer for structure http_cache_control_t.

A static http_cache_control_t structure must be initialized with the HTTP_CACHE_CONTROL_INIT() macro. For instance,

  http_cache_control_t http_cache_control = HTTP_CACHE_CONTROL_INIT;

#define HTTPTAG_CACHE_CONTROL

(

x

)

Tag list item for pointer to a Cache-Control header object.

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

Parameters:

x

pointer to a http_cache_control_t header structure, or NULL.

#define HTTPTAG_CACHE_CONTROL_STR

(

s

)

Tag list item for string with Cache-Control header value.

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

Parameters:

s

pointer to a string containing http_cache_control_t value, or NULL.

The HTTPTAG_CACHE_CONTROL_STR string can be converted to a http_cache_control_t header structure by giving the string s has second argument to function http_cache_control_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_cache_control_hash

Hash of Cache-Control header.

---

Function Documentation

http_cache_control_t * http_cache_control_copy	(	su_home_t *	home,
		http_cache_control_t const *	hdr
	)			[inline]

Copy a http_cache_control_t header structure.

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

   cache_control = http_cache_control_copy(home, http->http_cache_control);

Returns:

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

http_cache_control_t * http_cache_control_dup	(	su_home_t *	home,
		http_cache_control_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_cache_control_t.

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

   cache_control = http_cache_control_dup(home, http->http_cache_control);

Returns:

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

http_cache_control_t * http_cache_control_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Cache-Control header from formatting result.

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

http_cache_control_t* http_cache_control_init

(

http_cache_control_t

x[1]

)

[inline]

Initialize a structure http_cache_control_t.

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

  http_cache_control_t http_cache_control;

  http_cache_control_init(&http_cache_control);

http_cache_control_t * http_cache_control_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_cache_control_t.

The function http_cache_control_make() makes a new http_cache_control_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_cache_control_make() returns a pointer to newly maked http_cache_control_t header structure, or NULL upon an error.

int http_is_cache_control

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_cache_control_t.

The function http_is_cache_control() returns true (nonzero) if the header class is an instance of Cache-Control header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

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

---

Variable Documentation

msg_hclass_t http_cache_control_class[]

Header class for HTTP Cache-Control header.

The header class http_cache_control_class defines how a HTTP Cache-Control header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_cache_control_t header structure.