Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server. More...

#include <cookie.h>

Public Member Functions
	cookie (const std::string &name, const std::string &value)
	Constructs a cookie with a specified name and value. More...

	cookie (std::string &&name, std::string &&value)
	Constructs a cookie with a specified name and value. More...

	cookie (std::string &&name, const std::string &value)
	Constructs a cookie with a specified name and value. More...

	cookie (const std::string &name, std::string &&value)
	Constructs a cookie with a specified name and value. More...

	cookie (const cookie &c)=default
	Copy constructor. More...

	cookie (cookie &&c)=default
	Move constructor. More...

cookie &	operator= (const cookie &c)=default
	Copy assignment operator. More...

cookie &	operator= (cookie &&c)=default
	Move assignment operator. More...

	~cookie () noexcept=default
	Destructor.

const std::string &	get_name () const
	Returns the name of the cookie. More...

const std::string &	get_value () const
	Returns the value of the cookie. More...

const std::string &	get_comment () const
	Returns the comment describing the purpose of this cookie, or empty string if the cookie has no comment. More...

const std::string &	get_domain () const
	Returns the domain name set for this cookie. More...

long	get_max_age () const
	Returns the maximum age of the cookie, specified in seconds, By default, `-1` indicating the cookie will persist until browser shutdown. More...

const std::string &	get_path () const
	Returns the path on the server to which the browser returns this cookie. More...

bool	is_secure () const
	Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol. More...

int	get_version () const
	Returns the version of the protocol this cookie complies with. More...

bool	is_http_only () const
	Gets the flag that controls if this cookie will be hidden from scripts on the client side. More...

void	set_value (const std::string &value)
	Assigns a new value to a cookie after the cookie is created. More...

void	set_value (std::string &&value)
	Assigns a new value to a cookie after the cookie is created. More...

void	set_comment (const std::string &comment)
	Specifies a comment that describes a cookie's purpose. More...

void	set_comment (std::string &&comment)
	Specifies a comment that describes a cookie's purpose. More...

void	set_domain (const std::string &domain)
	Specifies the domain within which this cookie should be presented. More...

void	set_domain (std::string &&domain)
	Specifies the domain within which this cookie should be presented. More...

void	set_max_age (long max_age)
	Sets the maximum age of the cookie in seconds. More...

void	set_path (const std::string &path)
	Specifies a path for the cookie to which the client should return the cookie. More...

void	set_path (std::string &&path)
	Specifies a path for the cookie to which the client should return the cookie. More...

void	set_secure (bool secure)
	Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL. More...

void	set_version (int version)
	Sets the version of the cookie protocol this cookie complies with. More...

void	set_http_only (bool http_only)
	Sets the flag that controls if this cookie will be hidden from scripts on the client side. More...

std::string	to_string () const
	Converts this cookie into its string representation. More...

Detailed Description

Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server.

A cookie's value can uniquely identify a client, so cookies are commonly used for session management.

A cookie has a name, a single value, and optional attributes such as a comment, path and domain qualifiers, a maximum age, and a version number. Some Web browsers have bugs in how they handle the optional attributes, so use them sparingly to improve the interoperability of your servlets.

The servlet sends cookies to the browser by using the http_response::add_cookie method, which adds fields to HTTP response headers to send cookies to the browser, one at a time. The browser is expected to support 20 cookies for each Web server, 300 cookies total, and may limit cookie size to 4 KB each.

The browser returns cookies to the servlet by adding fields to HTTP request headers. Cookies can be retrieved from a request by using the http_request::get_cookies method. Several cookies might have the same name but different path attributes.

Cookies affect the caching of the Web pages that use them. HTTP 1.0 does not cache pages that use cookies created with this class. This class does not support the cache control defined with HTTP 1.1.

This class supports both the Version 0 (by Netscape) and Version 1 (by RFC 2109) cookie specifications. By default, cookies are created using Version 0 to ensure the best interoperability.

Constructor & Destructor Documentation

servlet::cookie::cookie	(	const std::string &	name,
		const std::string &	value
	)

inline

Constructs a cookie with a specified name and value.

The name must conform to RFC 2109. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a $ character. The cookie's name cannot be changed after creation.

The value can be anything the server chooses to send. Its value is probably of interest only to the server. The cookie's value can be changed after creation with the setValue method.

By default, cookies are created according to the Netscape cookie specification. The version can be changed with the set_version method.

Parameters

name	a `std::string` specifying the name of the cookie
value	a `std::string` specifying the value of the cookie

See Also: set_value; set_version

servlet::cookie::cookie	(	std::string &&	name,
		std::string &&	value
	)

inline

Constructs a cookie with a specified name and value.

Same as cookie(const std::string&, const std::string&), except the arguments are moved.

Parameters

name	a `std::string` specifying the name of the cookie
value	a `std::string` specifying the value of the cookie

See Also: cookie(const std::string&, const std::string&)

servlet::cookie::cookie	(	std::string &&	name,
		const std::string &	value
	)

inline

Constructs a cookie with a specified name and value.

Same as cookie(const std::string&, const std::string&), except name argument is moved.

Parameters

name	a `std::string` specifying the name of the cookie
value	a `std::string` specifying the value of the cookie

See Also: cookie(const std::string&, const std::string&)

servlet::cookie::cookie	(	const std::string &	name,
		std::string &&	value
	)

inline

Constructs a cookie with a specified name and value.

Same as cookie(const std::string&, const std::string&), except value argument is moved.

Parameters

name	a `std::string` specifying the name of the cookie
value	a `std::string` specifying the value of the cookie

See Also: cookie(const std::string&, const std::string&)

servlet::cookie::cookie ( const cookie & c )

default

Copy constructor.

Parameters

c	Object to copy from

servlet::cookie::cookie ( cookie && c )

default

Move constructor.

Parameters

c	Object to move from

Member Function Documentation

const std::string& servlet::cookie::get_comment ( ) const

inline

Returns the comment describing the purpose of this cookie, or empty string if the cookie has no comment.

Returns: a String containing the comment, or null if none

See Also: set_comment

const std::string& servlet::cookie::get_domain ( ) const

inline

Returns the domain name set for this cookie.

The form of the domain name is set by RFC 2109.

Returns: a std::string containing the domain name

See Also: set_domain

long servlet::cookie::get_max_age ( ) const

inline

Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating the cookie will persist until browser shutdown.

Returns: a long specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown

See Also: set_max_age

const std::string& servlet::cookie::get_name ( ) const

inline

Returns the name of the cookie.

The name cannot be changed after creation.

Returns: a std::string specifying the cookie's name

const std::string& servlet::cookie::get_path ( ) const

inline

Returns the path on the server to which the browser returns this cookie.

The cookie is visible to all subpaths on the server.

Returns: a std::string specifying a path that contains a servlet name, for example, /catalog

See Also: set_path

const std::string& servlet::cookie::get_value ( ) const

inline

Returns the value of the cookie.

Returns: a std::string containing the cookie's present value

See Also: set_value; cookie

int servlet::cookie::get_version ( ) const

inline

Returns the version of the protocol this cookie complies with.

Version 1 complies with RFC 2109, and version 0 complies with the original cookie specification drafted by Netscape. Cookies provided by a browser use and identify the browser's cookie version.

Returns: 0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2109

See Also: set_version

bool servlet::cookie::is_http_only ( ) const

inline

Gets the flag that controls if this cookie will be hidden from scripts on the client side.

Returns: true if the cookie is hidden from scripts, else false

bool servlet::cookie::is_secure ( ) const

inline

Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

Returns: true if the browser uses a secure protocol; otherwise, true

See Also: set_secure

cookie& servlet::cookie::operator= ( const cookie & c )

default

Copy assignment operator.

Parameters

c	Object to copy from

cookie& servlet::cookie::operator= ( cookie && c )

default

Move assignment operator.

Parameters

c	Object to move from

void servlet::cookie::set_comment ( const std::string & comment )

inline

Specifies a comment that describes a cookie's purpose.

The comment is useful if the browser presents the cookie to the user. Comments are not supported by Netscape Version 0 cookies.

Parameters

comment a std::string specifying the comment to display to the user

See Also: get_comment

void servlet::cookie::set_comment ( std::string && comment )

inline

Specifies a comment that describes a cookie's purpose.

Same as set_comment(const std::string&) except the argument is moved

Parameters

comment a std::string specifying the comment to display to the user

See Also: set_comment(const std::string&)

void servlet::cookie::set_domain ( const std::string & domain )

inline

Specifies the domain within which this cookie should be presented.

The form of the domain name is specified by RFC 2109. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them.

Parameters

domain a std::string containing the domain name within which this cookie is visible; form is according to RFC 2109

See Also: get_domain

void servlet::cookie::set_domain ( std::string && domain )

inline

Specifies the domain within which this cookie should be presented.

Same as set_domain(const std::string&) except the argument is moved

Parameters

domain a std::string containing the domain name within which this cookie is visible; form is according to RFC 2109

See Also: set_domain(const std::string&)

void servlet::cookie::set_http_only ( bool http_only )

inline

Sets the flag that controls if this cookie will be hidden from scripts on the client side.

Parameters

http_only The new value of the flag

void servlet::cookie::set_max_age ( long max_age )

inline

Sets the maximum age of the cookie in seconds.

A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.

A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.

Parameters

max_age an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie

See Also: get_max_age

void servlet::cookie::set_path ( const std::string & path )

inline

Specifies a path for the cookie to which the client should return the cookie.

The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog.

Consult RFC 2109 (available on the Internet) for more information on setting path names for cookies.

Parameters

path	a `std::string` specifying a path

See Also: get_path

void servlet::cookie::set_path ( std::string && path )

inline

Specifies a path for the cookie to which the client should return the cookie.

Same as set_path(const std::string&) except the argument is moved

Parameters

path	a `std::string` specifying a path

See Also: set_path(const std::string&)

void servlet::cookie::set_secure ( bool secure )

inline

Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

The default value is false.

Parameters

secure if true, sends the cookie from the browser to the server only when using a secure protocol; if false, sent on any protocol

See Also: is_secure

void servlet::cookie::set_value ( const std::string & value )

inline

Assigns a new value to a cookie after the cookie is created.

If you use a binary value, you may want to use BASE64 encoding.

With Version 0 cookies, values should not contain white space, brackets, parentheses, equals signs, commas, double quotes, slashes, question marks, at signs, colons, and semicolons. Empty values may not behave the same way on all browsers.

Parameters

value a std::string specifying the new value

See Also: get_value; cookie

void servlet::cookie::set_value ( std::string && value )

inline

Assigns a new value to a cookie after the cookie is created.

Same as set_value(const std::string&) except the argument is moved

Parameters

value a std::string specifying the new value

See Also: set_value(const std::string&)

void servlet::cookie::set_version ( int version )

inline

Sets the version of the cookie protocol this cookie complies with.

Version 0 complies with the original Netscape cookie specification. Version 1 complies with RFC 2109.

Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.

Parameters

version 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2109

See Also: get_version

std::string servlet::cookie::to_string ( ) const

Converts this cookie into its string representation.

Returns: a std::string representation of this cookie.

The documentation for this class was generated from the following file:

include/servlet/cookie.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation