CopperSpice API  1.7.2
QNetworkCookie Class Reference

Class holds one network cookie. More...

Public Types

enum  RawForm
 

Public Methods

 QNetworkCookie (const QByteArray &name=QByteArray (), const QByteArray &value=QByteArray ())
 
 QNetworkCookie (const QNetworkCookie &other)
 
 ~QNetworkCookie ()
 
QString domain () const
 
QDateTime expirationDate () const
 
bool hasSameIdentifier (const QNetworkCookie &other) const
 
bool isHttpOnly () const
 
bool isSecure () const
 
bool isSessionCookie () const
 
QByteArray name () const
 
void normalize (const QUrl &url)
 
bool operator!= (const QNetworkCookie &other) const
 
QNetworkCookie & operator= (const QNetworkCookie &other)
 
QNetworkCookie & operator= (QNetworkCookie &&other)
 
bool operator== (const QNetworkCookie &other) const
 
QString path () const
 
void setDomain (const QString &domain)
 
void setExpirationDate (const QDateTime &date)
 
void setHttpOnly (bool enable)
 
void setName (const QByteArray &cookieName)
 
void setPath (const QString &path)
 
void setSecure (bool enable)
 
void setValue (const QByteArray &value)
 
void swap (QNetworkCookie &other)
 
QByteArray toRawForm (RawForm form=Full) const
 
QByteArray value () const
 

Static Public Methods

static QList< QNetworkCookie > parseCookies (const QByteArray &cookieString)
 

Detailed Description

The QNetworkCookie class holds one network cookie. Cookies are small bits of information that stateless protocols like HTTP use to maintain some persistent information across requests. A cookie is set by a remote server when it replies to a request and it expects the same cookie to be sent back when further requests are sent.

QNetworkCookie holds one such cookie as received from the network. A cookie has a name and a value, but those are opaque to the application. In other words, the information stored in them has no meaning to the application. A cookie has an associated path name and domain, which indicate when the cookie should be sent again to the server.

A cookie can also have an expiration date, indicating its validity. If the expiration date is not present, the cookie is considered a "session cookie" and should be discarded when the application exits (or when its concept of session is over).

QNetworkCookie provides a way of parsing a cookie from the HTTP header format using the QNetworkCookie::parseCookies() method. However, when received in a QNetworkReply, the cookie is already parsed.

This class implements cookies as described by the Netscape Cookie Specification which is similar to the RFC 2109 specification. The more recent RFC 2965 specification (which uses the Set-Cookie2 header) is not currently supported.

See also
QNetworkCookieJar, QNetworkRequest, QNetworkReply

Member Enumeration Documentation

This enum is used with the toRawForm() method to declare which form of a cookie shall be returned. Only the Full form of the cookie can be parsed back into its original contents.

ConstantValueDescription
QNetworkCookie::NameAndValueOnly0makes toRawForm() return only the "NAME=VALUE" part of the cookie, as suitable for sending back to a server in a client request's "Cookie:" header. Multiple cookies are separated by a semi-colon in the "Cookie:" header field.
QNetworkCookie::Full1makes toRawForm() return the full cookie contents, as suitable for sending to a client in a server's "Set-Cookie:" header.
See also
toRawForm(), parseCookies()

Constructor & Destructor Documentation

QNetworkCookie::QNetworkCookie ( const QByteArray name = QByteArray(),
const QByteArray value = QByteArray() 
)
explicit

Create a new QNetworkCookie object, initializing the cookie name to name and its value to value. A cookie is only valid if it has a name. However, the value is opaque to the application and being empty may have significance to the remote server.

QNetworkCookie::QNetworkCookie ( const QNetworkCookie &  other)

Creates a new QNetworkCookie object by copying the contents of other.

QNetworkCookie::~QNetworkCookie ( )

Destroys this QNetworkCookie object.

Method Documentation

QString QNetworkCookie::domain ( ) const

Returns the domain this cookie is associated with. This corresponds to the "domain" field of the cookie string. The domain here may start with a dot, which is not a valid hostname. However, it means this cookie matches all hostnames ending with that domain name.

See also
setDomain()
QDateTime QNetworkCookie::expirationDate ( ) const

Returns the expiration date for this cookie. If this cookie is a session cookie, the QDateTime returned will not be valid. If the date is in the past, this cookie has already expired and should not be sent again back to a remote server.

The expiration date corresponds to the parameters of the "expires" entry in the cookie string.

See also
isSessionCookie(), setExpirationDate()
bool QNetworkCookie::hasSameIdentifier ( const QNetworkCookie &  other) const

Returns true if this cookie has the same identifier tuple as other. The identifier tuple is composed of the name, domain and path.

See also
operator==()
bool QNetworkCookie::isHttpOnly ( ) const

Returns true if the HttpOnly flag is enabled for this cookie. A cookie that is HttpOnly is only set and retrieved by the network requests and replies. For example, the HTTP protocol. It is not accessible from scripts running on browsers.

See also
isSecure()
bool QNetworkCookie::isSecure ( ) const

Returns true if the "secure" option was specified in the cookie string, false otherwise. Secure cookies may contain private information and should not be resent over unencrypted connections.

See also
setSecure()
bool QNetworkCookie::isSessionCookie ( ) const

Returns true if this cookie is a session cookie. A session cookie is a cookie which has no expiration date, which means it should be discarded when the application's concept of session is over (usually, when the application exits).

See also
expirationDate(), setExpirationDate()
QByteArray QNetworkCookie::name ( ) const

Returns the name of this cookie. The only mandatory field of a cookie is its name, without which it is not considered valid.

See also
setName(), value()
void QNetworkCookie::normalize ( const QUrl url)

This method normalizes the path and domain of the cookie if they were previously empty. The url parameter is used to determine the correct domain and path.

bool QNetworkCookie::operator!= ( const QNetworkCookie &  other) const
inline

Returns true if this cookie is not equal to other.

See also
operator==()
QNetworkCookie & QNetworkCookie::operator= ( const QNetworkCookie &  other)

Copy assigns from other and returns a reference to this object.

QNetworkCookie & QNetworkCookie::operator= ( QNetworkCookie &&  other)
inline

Move assigns from other and returns a reference to this object.

bool QNetworkCookie::operator== ( const QNetworkCookie &  other) const

Returns true if this cookie is equal to other. This method only returns true if all fields of the cookie are the same. However, in some contexts two cookies of the same name could be considered equal.

See also
operator!=()
QList< QNetworkCookie > QNetworkCookie::parseCookies ( const QByteArray cookieString)
static

Parses the cookie string cookieString as received from a server response in the "Set-Cookie" header. If there is a parsing error, this method returns an empty list.

Since the HTTP header can set more than one cookie at the same time, this method returns a QList<QNetworkCookie>, one for each cookie that is parsed.

See also
toRawForm()
QString QNetworkCookie::path ( ) const

Returns the path associated with this cookie. This corresponds to the "path" field of the cookie string.

See also
setPath()
void QNetworkCookie::setDomain ( const QString domain)

Sets the domain associated with this cookie to be domain.

See also
domain()
void QNetworkCookie::setExpirationDate ( const QDateTime date)

Sets the expiration date of this cookie to date. Setting an invalid expiration date to this cookie will mean it's a session cookie.

See also
isSessionCookie(), expirationDate()
void QNetworkCookie::setHttpOnly ( bool  enable)

Sets this cookie's "HttpOnly" flag to enable.

See also
isHttpOnly()
void QNetworkCookie::setName ( const QByteArray cookieName)

Sets the name of this cookie to be cookieName. Note that setting a cookie name to an empty QByteArray will make this cookie invalid.

See also
name(), value()
void QNetworkCookie::setPath ( const QString path)

Sets the path associated with this cookie to be path.

See also
path()
void QNetworkCookie::setSecure ( bool  enable)

Sets the secure flag of this cookie to enable.

Secure cookies may contain private information and should not be resent over unencrypted connections.

See also
isSecure()
void QNetworkCookie::setValue ( const QByteArray value)

Sets the value of this cookie to be value.

See also
value(), name()
void QNetworkCookie::swap ( QNetworkCookie &  other)
inline

Swaps this cookie with other. This function is very fast and never fails.

QByteArray QNetworkCookie::toRawForm ( RawForm  form = Full) const

Returns the raw form of this QNetworkCookie. The QByteArray returned by this method is suitable for an HTTP header, either in a server response (the Set-Cookie header) or the client request (the Cookie header). You can choose from one of two formats, using form.

See also
parseCookies()
QByteArray QNetworkCookie::value ( ) const

Returns this cookies value, as specified in the cookie string. Note that a cookie is still valid if its value is empty.

Cookie name-value pairs are considered opaque to the application: that is, their values do not mean anything.

See also
setValue(), name()