Set-Cookie extension header.

The Set-Cookie header is used to transmit state information from server back to the http client. More...

Defines
#define	HTTP_SET_COOKIE_INIT()
	Initializer for structure http_set_cookie_t.
#define	HTTPTAG_SET_COOKIE(x)
	Tag list item for pointer to a Set-Cookie header object.
#define	HTTPTAG_SET_COOKIE_STR(s)
	Tag list item for string with Set-Cookie header value.
Typedefs
typedef struct http_set_cookie_s	http_set_cookie_t
	The structure http_set_cookie_t contains representation of Set-Cookie header.
Enumerations
enum	{ http_set_cookie_hash }
Functions
http_set_cookie_t *	http_set_cookie_init (http_set_cookie_t x[1])
	Initialize a structure http_set_cookie_t.
int	http_is_set_cookie (http_header_t const *header)
	Test if header object is instance of http_set_cookie_t.
http_set_cookie_t *	http_set_cookie_dup (su_home_t *home, http_set_cookie_t const *hdr))
	Duplicate (deep copy) http_set_cookie_t.
http_set_cookie_t *	http_set_cookie_copy (su_home_t *home, http_set_cookie_t const *hdr))
	Copy a http_set_cookie_t header structure.
http_set_cookie_t *	http_set_cookie_make (su_home_t *home, char const *s))
	Make a header structure http_set_cookie_t.
http_set_cookie_t *	http_set_cookie_format (su_home_t *home, char const *fmt,...)))
	Make a Set-Cookie header from formatting result.
Variables
msg_hclass_t	http_set_cookie_class []
	Header class for HTTP Set-Cookie header.
msg_parse_f	http_set_cookie_d
	Decode (parse) a Set-Cookie header.
msg_print_f	http_set_cookie_e
	Encode (print) a Set-Cookie header.

---

Detailed Description

The Set-Cookie header is used to transmit state information from server back to the http client.

Its syntax is defined in RFC 2109 section 4.2.2 as follows:

 set-cookie      =       "Set-Cookie:" cookies
 cookies         =       1#cookie
 cookie          =       NAME "=" VALUE *(";" cookie-av)
 NAME            =       attr
 VALUE           =       value
 cookie-av       =       "Comment" "=" value
                 |       "Domain" "=" value
                 |       "Max-Age" "=" value
                 |       "Path" "=" value
                 |       "Secure"
                 |       "Version" "=" 1*DIGIT

---

Define Documentation

#define HTTP_SET_COOKIE_INIT

(

)

Initializer for structure http_set_cookie_t.

A static http_set_cookie_t structure must be initialized with the HTTP_SET_COOKIE_INIT() macro. For instance,

  http_set_cookie_t http_set_cookie = HTTP_SET_COOKIE_INIT;

#define HTTPTAG_SET_COOKIE

(

x

)

Tag list item for pointer to a Set-Cookie header object.

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

Parameters:

x

pointer to a http_set_cookie_t header structure, or NULL.

#define HTTPTAG_SET_COOKIE_STR

(

s

)

Tag list item for string with Set-Cookie header value.

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

Parameters:

s

pointer to a string containing http_set_cookie_t value, or NULL.

The HTTPTAG_SET_COOKIE_STR string can be converted to a http_set_cookie_t header structure by giving the string s has second argument to function http_set_cookie_make().

---

Typedef Documentation

typedef struct http_set_cookie_s http_set_cookie_t

The structure http_set_cookie_t contains representation of Set-Cookie header.

The http_set_cookie_t is defined as follows:

 typedef struct http_set_cookie_s
 {
 } http_set_cookie_t;

---

Enumeration Type Documentation

anonymous enum

Enumerator:

http_set_cookie_hash

Hash of Set-Cookie header.

---

Function Documentation

int http_is_set_cookie

(

http_header_t const *

header

)

[inline]

Test if header object is instance of http_set_cookie_t.

The function http_is_set_cookie() returns true (nonzero) if the header class is an instance of Set-Cookie header object and false (zero) otherwise.

Parameters:

header

pointer to the header structure to be tested

Returns:

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

http_set_cookie_t * http_set_cookie_copy	(	su_home_t *	home,
		http_set_cookie_t const *	hdr
	)			[inline]

Copy a http_set_cookie_t header structure.

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

   set_cookie = http_set_cookie_copy(home, http->http_set_cookie);

Returns:

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

http_set_cookie_t * http_set_cookie_dup	(	su_home_t *	home,
		http_set_cookie_t const *	hdr
	)			[inline]

Duplicate (deep copy) http_set_cookie_t.

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

   set_cookie = http_set_cookie_dup(home, http->http_set_cookie);

Returns:

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

http_set_cookie_t * http_set_cookie_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Set-Cookie header from formatting result.

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

http_set_cookie_t* http_set_cookie_init

(

http_set_cookie_t

x[1]

)

[inline]

Initialize a structure http_set_cookie_t.

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

  http_set_cookie_t http_set_cookie;

  http_set_cookie_init(&http_set_cookie);

http_set_cookie_t * http_set_cookie_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a header structure http_set_cookie_t.

The function http_set_cookie_make() makes a new http_set_cookie_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_set_cookie_make() returns a pointer to newly maked http_set_cookie_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t http_set_cookie_class[]

Header class for HTTP Set-Cookie header.

The header class http_set_cookie_class defines how a HTTP Set-Cookie header is parsed and printed. It also contains methods used by HTTP parser and other functions to manipulate the http_set_cookie_t header structure.