QtBase  v6.3.1
Public Slots | Public Member Functions | Protected Member Functions | List of all members
QAbstractNetworkCache Class Referenceabstract

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

#include <qabstractnetworkcache.h>

Inheritance diagram for QAbstractNetworkCache:
Inheritance graph
[legend]
Collaboration diagram for QAbstractNetworkCache:
Collaboration graph
[legend]

Public Slots

virtual void clear ()=0
 
- Public Slots inherited from QObject
void deleteLater ()
 

Public Member Functions

virtual ~QAbstractNetworkCache ()
 
virtual QNetworkCacheMetaData metaData (const QUrl &url)=0
 
virtual void updateMetaData (const QNetworkCacheMetaData &metaData)=0
 
virtual QIODevicedata (const QUrl &url)=0
 
virtual bool remove (const QUrl &url)=0
 
virtual qint64 cacheSize () const =0
 
virtual QIODeviceprepare (const QNetworkCacheMetaData &metaData)=0
 
virtual void insert (QIODevice *device)=0
 
- 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< QStringbindableObjectName ()
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const noexcept
 
bool blockSignals (bool b) noexcept
 
QThreadthread () 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< TfindChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
template<typename T >
QList< TfindChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 
const QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 
bool inherits (const char *classname) const
 

Protected Member Functions

 QAbstractNetworkCache (QObject *parent=nullptr)
 
 QAbstractNetworkCache (QAbstractNetworkCachePrivate &dd, QObject *parent)
 
- Protected Member Functions inherited from QObject
QObjectsender () 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

- 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< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object More...
 

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 111 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 445 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 425 of file qabstractnetworkcache.cpp.

◆ QAbstractNetworkCache() [2/2]

QAbstractNetworkCache::QAbstractNetworkCache ( QAbstractNetworkCachePrivate dd,
QObject parent 
)
protected

Definition at line 433 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 MySpyMemoryCache, MyMemoryCache, and 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()

Implemented in MySpyMemoryCache, and MyMemoryCache.

◆ 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 MySpyMemoryCache, MyMemoryCache, NetworkDiskCache, QNetworkDiskCache, and NetworkDiskCache.

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, MySpyMemoryCache, and MyMemoryCache.

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 NetworkDiskCache, MyMemoryCache, QNetworkDiskCache, and MySpyMemoryCache.

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 MySpyMemoryCache, QNetworkDiskCache, and MyMemoryCache.

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 MySpyMemoryCache, MyMemoryCache, and QNetworkDiskCache.

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 MyMemoryCache, QNetworkDiskCache, and MySpyMemoryCache.


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