QNetworkCookieJar Class Reference

The QNetworkCookieJar class implements a simple jar of QNetworkCookie objects. More...

#include <qnetworkcookiejar.h>

Inheritance diagram for QNetworkCookieJar:

Collaboration diagram for QNetworkCookieJar:

Public Member Functions
	QNetworkCookieJar (QObject *parent=nullptr)
virtual	~QNetworkCookieJar ()
virtual QList< QNetworkCookie >	cookiesForUrl (const QUrl &url) const
virtual bool	setCookiesFromUrl (const QList< QNetworkCookie > &cookieList, const QUrl &url)
virtual bool	insertCookie (const QNetworkCookie &cookie)
virtual bool	updateCookie (const QNetworkCookie &cookie)
virtual bool	deleteCookie (const QNetworkCookie &cookie)
Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
virtual	~QObject ()
virtual bool	event (QEvent *event)
virtual bool	eventFilter (QObject *watched, QEvent *event)
QString	objectName () const
void	setObjectName (const QString &name)
QBindable< QString >	bindableObjectName ()
bool	isWidgetType () const
bool	isWindowType () const
bool	signalsBlocked () const noexcept
bool	blockSignals (bool b) noexcept
QThread *	thread () const
void	moveToThread (QThread *thread)
int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
void	killTimer (int id)
template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
const QObjectList &	children () const
void	setParent (QObject *parent)
void	installEventFilter (QObject *filterObj)
void	removeEventFilter (QObject *obj)
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool	disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool	disconnect (const QObject *receiver, const char *member=nullptr) const
void	dumpObjectTree () const
void	dumpObjectInfo () const
bool	setProperty (const char *name, const QVariant &value)
QVariant	property (const char *name) const
QList< QByteArray >	dynamicPropertyNames () const
QBindingStorage *	bindingStorage ()
const QBindingStorage *	bindingStorage () const
QObject *	parent () const
bool	inherits (const char *classname) const

Protected Member Functions
QList< QNetworkCookie >	allCookies () const
void	setAllCookies (const QList< QNetworkCookie > &cookieList)
virtual bool	validateCookie (const QNetworkCookie &cookie, const QUrl &url) const
Protected Member Functions inherited from QObject
QObject *	sender () const
int	senderSignalIndex () const
int	receivers (const char *signal) const
bool	isSignalConnected (const QMetaMethod &signal) const
virtual void	timerEvent (QTimerEvent *event)
virtual void	childEvent (QChildEvent *event)
virtual void	customEvent (QEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	disconnectNotify (const QMetaMethod &signal)
	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
void	objectNameChanged (const QString &objectName, QPrivateSignal)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
static QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)
template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)
static bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
static bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool	disconnect (const QMetaObject::Connection &)
template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Properties inherited from QObject
QString	objectName
	the name of this object More...
Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()
template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()
	QObjectList

Detailed Description

The QNetworkCookieJar class implements a simple jar of QNetworkCookie objects.

Since

4.4 \inmodule QtNetwork

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.

The cookie jar is the object that holds all cookies set in previous requests. Web browsers save their cookie jars to disk in order to conserve permanent cookies across invocations of the application.

QNetworkCookieJar does not implement permanent storage: it only keeps the cookies in memory. Once the QNetworkCookieJar object is deleted, all cookies it held will be discarded as well. If you want to save the cookies, you should derive from this class and implement the saving to disk to your own storage format.

This class implements only the basic security recommended by the cookie specifications and does not implement any cookie acceptance policy (it accepts all cookies set by any requests). In order to override those rules, you should reimplement the cookiesForUrl() and setCookiesFromUrl() virtual functions. They are called by QNetworkReply and QNetworkAccessManager when they detect new cookies and when they require cookies.

See also

QNetworkCookie, QNetworkAccessManager, QNetworkReply, QNetworkRequest, QNetworkAccessManager::setCookieJar()

Definition at line 53 of file qnetworkcookiejar.h.

Constructor & Destructor Documentation

QNetworkCookieJar()

QNetworkCookieJar::QNetworkCookieJar ( QObject *  parent = nullptr )

explicit

Creates a QNetworkCookieJar object and sets the parent object to be parent.

The cookie jar is initialized to empty.

Definition at line 105 of file qnetworkcookiejar.cpp.

~QNetworkCookieJar()

QNetworkCookieJar::~QNetworkCookieJar ( )

virtual

Destroys this cookie jar object and discards all cookies stored in it. Cookies are not saved to disk in the QNetworkCookieJar default implementation.

If you need to save the cookies to disk, you have to derive from QNetworkCookieJar and save the cookies to disk yourself.

Definition at line 118 of file qnetworkcookiejar.cpp.

Member Function Documentation

allCookies()

QList< QNetworkCookie > QNetworkCookieJar::allCookies ( ) const

protected

Returns all cookies stored in this cookie jar. This function is suitable for derived classes to save cookies to disk, as well as to implement cookie expiration and other policies.

See also

setAllCookies(), cookiesForUrl()

Definition at line 129 of file qnetworkcookiejar.cpp.

Here is the caller graph for this function:

cookiesForUrl()

QList< QNetworkCookie > QNetworkCookieJar::cookiesForUrl ( const QUrl &  url ) const

virtual

Returns the cookies to be added to when a request is sent to url. This function is called by the default QNetworkAccessManager::createRequest(), which adds the cookies returned by this function to the request being sent.

If more than one cookie with the same name is found, but with differing paths, the one with longer path is returned before the one with shorter path. In other words, this function returns cookies sorted decreasingly by path length.

The default QNetworkCookieJar class implements only a very basic security policy (it makes sure that the cookies' domain and path match the reply's). To enhance the security policy with your own algorithms, override cookiesForUrl().

See also

setCookiesFromUrl(), QNetworkAccessManager::setCookieJar()

Qt6?: remove when compliant with RFC6265

Definition at line 227 of file qnetworkcookiejar.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

deleteCookie()

bool QNetworkCookieJar::deleteCookie ( const QNetworkCookie &  cookie )

virtual

Since

5.0 Deletes from cookie jar the cookie found to have the same identifier as cookie.

Returns true if a cookie was deleted, false otherwise.

See also

QNetworkCookie::hasSameIdentifier()

Definition at line 333 of file qnetworkcookiejar.cpp.

Here is the caller graph for this function:

insertCookie()

bool QNetworkCookieJar::insertCookie ( const QNetworkCookie &  cookie )

virtual

Since

5.0 Adds cookie to this cookie jar.

Returns true if cookie was added, false otherwise.

If a cookie with the same identifier already exists in the cookie jar, it will be overridden.

Definition at line 292 of file qnetworkcookiejar.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setAllCookies()

void QNetworkCookieJar::setAllCookies ( const QList< QNetworkCookie > &  cookieList )

protected

Sets the internal list of cookies held by this cookie jar to be cookieList. This function is suitable for derived classes to implement loading cookies from permanent storage, or their own cookie acceptance policies by reimplementing setCookiesFromUrl().

See also

allCookies(), setCookiesFromUrl()

Definition at line 143 of file qnetworkcookiejar.cpp.

Here is the caller graph for this function:

setCookiesFromUrl()

bool QNetworkCookieJar::setCookiesFromUrl ( const QList< QNetworkCookie > &  cookieList, const QUrl &  url  )

virtual

Adds the cookies in the list cookieList to this cookie jar. Before being inserted cookies are normalized.

Returns true if one or more cookies are set for url, otherwise false.

If a cookie already exists in the cookie jar, it will be overridden by those in cookieList.

The default QNetworkCookieJar class implements only a very basic security policy (it makes sure that the cookies' domain and path match the reply's). To enhance the security policy with your own algorithms, override setCookiesFromUrl().

Also, QNetworkCookieJar does not have a maximum cookie jar size. Reimplement this function to discard older cookies to create room for new ones.

See also

cookiesForUrl(), QNetworkAccessManager::setCookieJar(), QNetworkCookie::normalize()

Definition at line 197 of file qnetworkcookiejar.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

updateCookie()

bool QNetworkCookieJar::updateCookie ( const QNetworkCookie &  cookie )

virtual

Since

5.0 If a cookie with the same identifier as cookie exists in this cookie jar it will be updated. This function uses insertCookie().

Returns true if cookie was updated, false if no cookie in the jar matches the identifier of cookie.

See also

QNetworkCookie::hasSameIdentifier()

Definition at line 318 of file qnetworkcookiejar.cpp.

Here is the call graph for this function:

validateCookie()

bool QNetworkCookieJar::validateCookie ( const QNetworkCookie &  cookie, const QUrl &  url  ) const

protectedvirtual

Since

5.0 Returns true if the domain and path of cookie are valid, false otherwise. The url parameter is used to determine if the domain specified in the cookie is allowed.

Definition at line 352 of file qnetworkcookiejar.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/network/access/qnetworkcookiejar.h
• src/network/access/qnetworkcookiejar.cpp