Via header.

Defines
#define	HTTP_VIA_INIT()
	Initializer for structure http_via_t.
#define	HTTPTAG_VIA(x)
	Tag list item for pointer to a Via header object.
#define	HTTPTAG_VIA_STR(s)
	Tag list item for string with Via header value.
Enumerations
enum	{ http_via_hash }
Functions
http_via_t *	http_via_init (http_via_t x[1])
	Initialize a structure http_via_t.
int	http_is_via (http_header_t const *header)
	Test if header object is instance of http_via_t.
http_via_t *	http_via_dup (su_home_t *home, http_via_t const *hdr))
	Duplicate (deep copy) http_via_t.
http_via_t *	http_via_copy (su_home_t *home, http_via_t const *hdr))
	Copy a http_via_t header structure.
http_via_t *	http_via_make (su_home_t *home, char const *s))
	Make a header structure http_via_t.
http_via_t *	http_via_format (su_home_t *home, char const *fmt,...)))
	Make a Via header from formatting result.
Variables
msg_hclass_t	http_via_class []
	Header class for HTTP Via header.
msg_parse_f	http_via_d
	Decode (parse) a Via header.
msg_print_f	http_via_e
	Encode (print) a Via header.

---

Detailed Description

    Via =  "Via" ":" 1#( received-protocol received-by [ comment ] )
    received-protocol = [ protocol-name "/" ] protocol-version
    protocol-name     = token
    protocol-version  = token
    received-by       = ( host [ ":" port ] ) | pseudonym
    pseudonym         = token

---

Define Documentation

#define HTTP_VIA_INIT

(

)

Initializer for structure http_via_t.

A static http_via_t structure must be initialized with the HTTP_VIA_INIT() macro. For instance,

  http_via_t http_via = HTTP_VIA_INIT;

#define HTTPTAG_VIA

(

x

)

Tag list item for pointer to a Via header object.

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

Parameters:

x

pointer to a http_via_t header structure, or NULL.

#define HTTPTAG_VIA_STR

(

s

)

Tag list item for string with Via header value.

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

Parameters:

s

pointer to a string containing http_via_t value, or NULL.

The HTTPTAG_VIA_STR string can be converted to a http_via_t header structure by giving the string s has second argument to function http_via_make().

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_via_hash

Hash of Via header.

---

Function Documentation

int http_is_via

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_via_t.

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

Parameters:

header

pointer to the header structure to be tested

Returns:

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

http_via_t * http_via_copy	(	su_home_t *	home,
		http_via_t const *	hdr
	)			[inline]

Copy a http_via_t header structure.

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

   via = http_via_copy(home, http->http_via);

Returns:

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

http_via_t * http_via_dup	(	su_home_t *	home,
		http_via_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_via_t.

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

   via = http_via_dup(home, http->http_via);

Returns:

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

http_via_t * http_via_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Via header from formatting result.

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

http_via_t* http_via_init

(

http_via_t

x[1]

)

[inline]

Initialize a structure http_via_t.

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

  http_via_t http_via;

  http_via_init(&http_via);

http_via_t * http_via_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_via_t.

The function http_via_make() makes a new http_via_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_via_make() returns a pointer to newly maked http_via_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_via_class[]

Header class for HTTP Via header.

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