HTTP status line.

The HTTP status line contains the HTTP protocol version, a reason code (100..599) and reason phrase. More...

Defines
#define	HTTP_STATUS_INIT()
	Initializer for structure http_status_t.
#define	HTTPTAG_STATUS(x)
	Tag list item for pointer to a status line object.
#define	HTTPTAG_STATUS_STR(s)
	Tag list item for string with status line value.
Enumerations
enum	{ http_status_hash }
Functions
http_status_t *	http_status_init (http_status_t x[1])
	Initialize a structure http_status_t.
int	http_is_status (http_header_t const *header)
	Test if header object is instance of http_status_t.
http_status_t *	http_status_dup (su_home_t *home, http_status_t const *hdr))
	Duplicate (deep copy) http_status_t.
http_status_t *	http_status_copy (su_home_t *home, http_status_t const *hdr))
	Copy a http_status_t header structure.
http_status_t *	http_status_make (su_home_t *home, char const *s))
	Make a header structure http_status_t.
http_status_t *	http_status_format (su_home_t *home, char const *fmt,...)))
	Make a status line from formatting result.
Variables
msg_hclass_t	http_status_class []
	Header class for HTTP status line.
msg_parse_f	http_status_d
	Decode (parse) a status line.
msg_print_f	http_status_e
	Encode (print) a status line.

---

Detailed Description

The HTTP status line contains the HTTP protocol version, a reason code (100..599) and reason phrase.

---

Define Documentation

#define HTTP_STATUS_INIT

(

)

Initializer for structure http_status_t.

A static http_status_t structure must be initialized with the HTTP_STATUS_INIT() macro. For instance,

  http_status_t http_status = HTTP_STATUS_INIT;

#define HTTPTAG_STATUS

(

x

)

Tag list item for pointer to a status line object.

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

Parameters:

x

pointer to a http_status_t header structure, or NULL.

#define HTTPTAG_STATUS_STR

(

s

)

Tag list item for string with status line value.

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

Parameters:

s

pointer to a string containing http_status_t value, or NULL.

The HTTPTAG_STATUS_STR string can be converted to a http_status_t header structure by giving the string s has second argument to function http_status_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_status_hash

Hash of status line.

---

Function Documentation

int http_is_status

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_status_t.

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

Parameters:

header

pointer to the header structure to be tested

Returns:

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

http_status_t * http_status_copy	(	su_home_t *	home,
		http_status_t const *	hdr
	)			[inline]

Copy a http_status_t header structure.

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

   status = http_status_copy(home, http->http_status);

Returns:

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

http_status_t * http_status_dup	(	su_home_t *	home,
		http_status_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_status_t.

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

   status = http_status_dup(home, http->http_status);

Returns:

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

http_status_t * http_status_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a status line from formatting result.

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

http_status_t* http_status_init

(

http_status_t

x[1]

)

[inline]

Initialize a structure http_status_t.

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

  http_status_t http_status;

  http_status_init(&http_status);

http_status_t * http_status_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_status_t.

The function http_status_make() makes a new http_status_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_status_make() returns a pointer to newly maked http_status_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_status_class[]

Header class for HTTP status line.

The header class http_status_class defines how a HTTP status line is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_status_t header structure.