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

#include <qabstractnetworkcache.h>

Inheritance diagram for QAbstractNetworkCache:

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

Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...

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

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

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

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

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

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

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

virtual	~QAbstractNetworkCache ()
	Destroys the cache. More...

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

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

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

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

void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...

QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...

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

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

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

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) 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. More...

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

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. More...

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

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

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

virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...

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

QString	objectName () const

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

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

Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...

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

void	setObjectName (const QString &name)

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

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

void	setUserData (uint id, QObjectUserData *data)

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

int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...

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

QObjectUserData *	userData (uint id) const

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

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

	QAbstractNetworkCache (QAbstractNetworkCachePrivate &dd, QObject *parent)

Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...

virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...

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

virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...

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

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

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 0. More...

int	senderSignalIndex () const

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

Additional Inherited Members
Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...

Static Public Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	Disconnects signal in object sender from method in object receiver. More...

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

static uint	registerUserData ()

static QString	tr (const char sourceText, const char comment=0, int n=-1)

static QString	trUtf8 (const char sourceText, const char comment=0, int n=-1)

Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...

Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject

Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

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

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()

T *	qobject_cast (QObject *object)

	QObjectList

void *	qt_find_obj_child (QObject parent, const char type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

The QAbstractNetworkCache class provides the interface for cache implementations.

Since: 4.5

Attention: Module: QtNetwork

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

See also: QNetworkDiskCache

Definition at line 109 of file qabstractnetworkcache.h.

Constructors and Destructors

◆ ~QAbstractNetworkCache()

QAbstractNetworkCache::~QAbstractNetworkCache ( )

virtual

Destroys the cache.

Any operations that have not been inserted are discarded.

See also: insert()

Definition at line 456 of file qabstractnetworkcache.cpp.

457 {

458 }

◆ QAbstractNetworkCache() [1/2]

QAbstractNetworkCache::QAbstractNetworkCache ( QObject * parent = 0 )

explicitprotected

Constructs an abstract network cache with the given parent.

Definition at line 436 of file qabstractnetworkcache.cpp.

     : QObject(*new QAbstractNetworkCachePrivate, parent)
 {
 }

◆ QAbstractNetworkCache() [2/2]

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

protected

Warning: This function is not part of the public interface.

Definition at line 444 of file qabstractnetworkcache.cpp.

     : QObject(dd, parent)
 {
 }

Functions

◆ 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 0 is returned.

In the base class this is a pure virtual function.

See also: metaData(), prepare()

Implemented in QNetworkDiskCache.

Referenced by QNetworkAccessCacheBackend::sendCacheContents(), and QNetworkAccessHttpBackend::sendCacheContents().

◆ 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 QNetworkReplyImplPrivate::completeCacheSave().

◆ 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 QNetworkAccessHttpBackend::loadFromCacheIfAllowed(), QNetworkAccessHttpBackend::replyDownloadMetaData(), and QNetworkAccessCacheBackend::sendCacheContents().

◆ 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 0 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 QNetworkReplyImplPrivate::initCacheSaveDevice().

◆ 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 QNetworkReplyImplPrivate::completeCacheSave(), QNetworkReplyImplPrivate::initCacheSaveDevice(), QNetworkAccessHttpBackend::invalidateCache(), and QNetworkReplyImplPrivate::setCachingEnabled().

◆ 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 QNetworkAccessHttpBackend::replyDownloadMetaData().

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

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

Public Slots

Public Functions

Protected Functions

Additional Inherited Members

Detailed Description

Constructors and Destructors

◆ ~QAbstractNetworkCache()

◆ QAbstractNetworkCache() [1/2]

◆ QAbstractNetworkCache() [2/2]

Functions

◆ cacheSize()

◆ clear

◆ data()

◆ insert()

◆ metaData()

◆ prepare()

◆ remove()

◆ updateMetaData()