The QAbstractNetworkCache class provides the interface for cache implementations. More...

#include <qabstractnetworkcache.h>

Inheritance diagram for QAbstractNetworkCache:

Collaboration diagram for QAbstractNetworkCache:

Public Slots
virtual void	clear ()=0
	Removes all items from the cache.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Public Member Functions
virtual	~QAbstractNetworkCache ()
	Destroys the cache.

virtual QNetworkCacheMetaData	metaData (const QUrl &url)=0
	Returns the meta data for the url url.

virtual void	updateMetaData (const QNetworkCacheMetaData &metaData)=0
	Updates the cache meta date for the metaData's url to metaData.

virtual QIODevice *	data (const QUrl &url)=0
	Returns the data associated with url.

virtual bool	remove (const QUrl &url)=0
	Removes the cache entry for url, returning true if success otherwise false.

virtual qint64	cacheSize () const =0
	Returns the current size taken up by the cache.

virtual QIODevice *	prepare (const QNetworkCacheMetaData &metaData)=0
	Returns the device that should be populated with the data for the cache item metaData.

virtual void	insert (QIODevice *device)=0
	Inserts the data in device and the prepared meta data into the cache.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

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
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
	QAbstractNetworkCache (QObject *parent=nullptr)
	Constructs an abstract network cache with the given parent.

	QAbstractNetworkCache (QAbstractNetworkCachePrivate &dd, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Additional Inherited Members
Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

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)
	\threadsafe

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::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a 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

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QAbstractNetworkCache class provides the interface for cache implementations.

Since: 4.5 \inmodule QtNetwork

QAbstractNetworkCache is the base class for every standard cache that is used by QNetworkAccessManager. QAbstractNetworkCache is an abstract class and cannot be instantiated.

See also: QNetworkDiskCache

Definition at line 75 of file qabstractnetworkcache.h.

Constructor & Destructor Documentation

◆ ~QAbstractNetworkCache()

QAbstractNetworkCache::~QAbstractNetworkCache ( )

virtual

Destroys the cache.

Any operations that have not been inserted are discarded.

See also: insert()

Definition at line 410 of file qabstractnetworkcache.cpp.

◆ QAbstractNetworkCache() [1/2]

QAbstractNetworkCache::QAbstractNetworkCache ( QObject * parent = nullptr )

explicitprotected

Constructs an abstract network cache with the given parent.

Definition at line 390 of file qabstractnetworkcache.cpp.

◆ QAbstractNetworkCache() [2/2]

QAbstractNetworkCache::QAbstractNetworkCache	(	QAbstractNetworkCachePrivate &	dd,
		QObject *	parent
	)

protected

Definition at line 398 of file qabstractnetworkcache.cpp.

Member Function Documentation

◆ cacheSize()

qint64 QAbstractNetworkCache::cacheSize ( ) const

pure virtual

Returns the current size taken up by the cache.

Depending upon the cache implementation this might be disk or memory size.

In the base class this is a pure virtual function.

See also: clear()

Implemented in QNetworkDiskCache.

◆ clear

void QAbstractNetworkCache::clear ( )

pure virtualslot

Removes all items from the cache.

Unless there was failures clearing the cache cacheSize() should return 0 after a call to clear.

In the base class this is a pure virtual function.

See also: cacheSize(), remove()

◆ data()

QIODevice * QAbstractNetworkCache::data ( const QUrl & url )

pure virtual

Returns the data associated with url.

It is up to the application that requests the data to delete the QIODevice when done with it.

If there is no cache for url, the url is invalid, or if there is an internal cache error \nullptr is returned.

In the base class this is a pure virtual function.

See also: metaData(), prepare()

Implemented in QNetworkDiskCache.

Referenced by QNetworkReplyHttpImplPrivate::loadFromCacheIfAllowed(), and QNetworkReplyHttpImplPrivate::sendCacheContents().

Here is the caller graph for this function:

◆ insert()

void QAbstractNetworkCache::insert ( QIODevice * device )

pure virtual

Inserts the data in device and the prepared meta data into the cache.

After this function is called the data and meta data should be retrievable using data() and metaData().

To cancel a prepared inserted call remove() on the metadata's url.

In the base class this is a pure virtual function.

See also: prepare(), remove()

Implemented in QNetworkDiskCache.

Referenced by QNetworkReplyHttpImplPrivate::completeCacheSave(), and QNetworkReplyImplPrivate::completeCacheSave().

Here is the caller graph for this function:

◆ metaData()

QNetworkCacheMetaData QAbstractNetworkCache::metaData ( const QUrl & url )

pure virtual

Returns the meta data for the url url.

If the url is valid and the cache contains the data for url, a valid QNetworkCacheMetaData is returned.

In the base class this is a pure virtual function.

See also: updateMetaData(), data()

Implemented in QNetworkDiskCache.

Referenced by QNetworkReplyHttpImplPrivate::loadFromCacheIfAllowed(), and QNetworkReplyHttpImplPrivate::replyDownloadMetaData().

Here is the caller graph for this function:

◆ prepare()

QIODevice * QAbstractNetworkCache::prepare ( const QNetworkCacheMetaData & metaData )

pure virtual

Returns the device that should be populated with the data for the cache item metaData.

When all of the data has been written insert() should be called. If metaData is invalid or the url in the metadata is invalid \nullptr is returned.

The cache owns the device and will take care of deleting it when it is inserted or removed.

To cancel a prepared inserted call remove() on the metadata's url.

In the base class this is a pure virtual function.

See also: remove(), updateMetaData(), insert()

Implemented in QNetworkDiskCache.

Referenced by QNetworkReplyHttpImplPrivate::initCacheSaveDevice(), and QNetworkReplyImplPrivate::initCacheSaveDevice().

Here is the caller graph for this function:

◆ remove()

bool QAbstractNetworkCache::remove ( const QUrl & url )

pure virtual

Removes the cache entry for url, returning true if success otherwise false.

In the base class this is a pure virtual function.

See also: clear(), prepare()

Implemented in QNetworkDiskCache.

Referenced by QNetworkReplyHttpImplPrivate::completeCacheSave(), QNetworkReplyImplPrivate::completeCacheSave(), QNetworkReplyHttpImplPrivate::initCacheSaveDevice(), QNetworkReplyImplPrivate::initCacheSaveDevice(), QNetworkReplyHttpImplPrivate::invalidateCache(), QNetworkReplyHttpImplPrivate::setCachingEnabled(), and QNetworkReplyImplPrivate::setCachingEnabled().

Here is the caller graph for this function:

◆ updateMetaData()

void QAbstractNetworkCache::updateMetaData ( const QNetworkCacheMetaData & metaData )

pure virtual

Updates the cache meta date for the metaData's url to metaData.

If the cache does not contains a cache item for the url then no action is taken.

In the base class this is a pure virtual function.

See also: metaData(), prepare()

Implemented in QNetworkDiskCache.

Referenced by QNetworkReplyHttpImplPrivate::replyDownloadMetaData().

Here is the caller graph for this function:

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

qtbase/src/network/access/qabstractnetworkcache.h
qtbase/src/network/access/qabstractnetworkcache.cpp

Public Slots

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~QAbstractNetworkCache()

◆ QAbstractNetworkCache() [1/2]

◆ QAbstractNetworkCache() [2/2]

Member Function Documentation

◆ cacheSize()

◆ clear

◆ data()

◆ insert()

◆ metaData()

◆ prepare()

◆ remove()

◆ updateMetaData()