Qt 4.8
|
The QNetworkDiskCache class provides a very basic disk cache. More...
#include <qnetworkdiskcache.h>
Public Slots | |
void | clear () |
Reimplemented Function More... | |
Public Slots inherited from QAbstractNetworkCache | |
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 | |
QString | cacheDirectory () const |
Returns the location where cached files will be stored. More... | |
qint64 | cacheSize () const |
Reimplemented Function More... | |
QIODevice * | data (const QUrl &url) |
Reimplemented Function More... | |
QNetworkCacheMetaData | fileMetaData (const QString &fileName) const |
Returns the QNetworkCacheMetaData for the cache file fileName. More... | |
void | insert (QIODevice *device) |
Reimplemented Function More... | |
qint64 | maximumCacheSize () const |
Returns the current maximum size in bytes for the disk cache. More... | |
QNetworkCacheMetaData | metaData (const QUrl &url) |
Reimplemented Function More... | |
QIODevice * | prepare (const QNetworkCacheMetaData &metaData) |
Reimplemented Function More... | |
QNetworkDiskCache (QObject *parent=0) | |
Creates a new disk cache. More... | |
bool | remove (const QUrl &url) |
Reimplemented Function More... | |
void | setCacheDirectory (const QString &cacheDir) |
Sets the directory where cached files will be stored to cacheDir. More... | |
void | setMaximumCacheSize (qint64 size) |
Sets the maximum size of the disk cache to be size in bytes. More... | |
void | updateMetaData (const QNetworkCacheMetaData &metaData) |
Reimplemented Function More... | |
~QNetworkDiskCache () | |
Destroys the cache object. More... | |
Public Functions inherited from QAbstractNetworkCache | |
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 | |
virtual qint64 | expire () |
Cleans the cache so that its size is under the maximum cache size. More... | |
Protected Functions inherited from QAbstractNetworkCache | |
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 ®Exp)() |
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... | |
The QNetworkDiskCache class provides a very basic disk cache.
QNetworkDiskCache stores each url in its own file inside of the cacheDirectory using QDataStream. Files with a text MimeType are compressed using qCompress. Each cache file starts with "cache_" and ends in ".cache". Data is written to disk only in insert() and updateMetaData().
Currently you can not share the same cache files with more then one disk cache.
QNetworkDiskCache by default limits the amount of space that the cache will use on the system to 50MB.
Note you have to set the cache directory before it will work.
A network disk cache can be enabled by:
When sending requests, to control the preference of when to use the cache and when to use the network, consider the following:
To check whether the response came from the cache or from the network, the following can be applied:
Definition at line 56 of file qnetworkdiskcache.h.
|
explicit |
Creates a new disk cache.
The parent argument is passed to QAbstractNetworkCache's constructor.
Definition at line 111 of file qnetworkdiskcache.cpp.
QNetworkDiskCache::~QNetworkDiskCache | ( | ) |
Destroys the cache object.
This does not clear the disk cache.
Definition at line 119 of file qnetworkdiskcache.cpp.
QString QNetworkDiskCache::cacheDirectory | ( | ) | const |
Returns the location where cached files will be stored.
Definition at line 132 of file qnetworkdiskcache.cpp.
Referenced by expire(), QNetworkDiskCachePrivate::prepareLayout(), and QNetworkDiskCachePrivate::tmpCacheFileName().
|
virtual |
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 169 of file qnetworkdiskcache.cpp.
|
slot |
Reimplemented Function
Definition at line 584 of file qnetworkdiskcache.cpp.
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 404 of file qnetworkdiskcache.cpp.
Referenced by QCacheItem::read(), updateMetaData(), and QCacheItem::writeCompressedData().
|
protectedvirtual |
Cleans the cache so that its size is under the maximum cache size.
Returns the current size of the cache.
When the current size of the cache is greater than the maximumCacheSize() older cache files are removed until the total size is less then 90% of maximumCacheSize() starting with the oldest ones first using the file creation date to determine how old a cache file is.
Subclasses can reimplement this function to change the order that cache files are removed taking into account information in the application knows about that QNetworkDiskCache does not, for example the number of times a cache is accessed.
Note: cacheSize() calls expire if the current cache size is unknown.
Definition at line 528 of file qnetworkdiskcache.cpp.
Referenced by cacheSize(), clear(), and setMaximumCacheSize().
QNetworkCacheMetaData QNetworkDiskCache::fileMetaData | ( | const QString & | fileName | ) | const |
Returns the QNetworkCacheMetaData for the cache file fileName.
If fileName is not a cache file QNetworkCacheMetaData will be invalid.
Definition at line 384 of file qnetworkdiskcache.cpp.
Referenced by metaData().
|
virtual |
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 238 of file qnetworkdiskcache.cpp.
Referenced by updateMetaData().
qint64 QNetworkDiskCache::maximumCacheSize | ( | ) | const |
Returns the current maximum size in bytes for the disk cache.
Definition at line 488 of file qnetworkdiskcache.cpp.
Referenced by expire(), and prepare().
|
virtual |
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 368 of file qnetworkdiskcache.cpp.
Referenced by QCacheItem::canCompress(), prepare(), QCacheItem::read(), and QCacheItem::writeHeader().
|
virtual |
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 187 of file qnetworkdiskcache.cpp.
Referenced by updateMetaData().
|
virtual |
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 319 of file qnetworkdiskcache.cpp.
void QNetworkDiskCache::setCacheDirectory | ( | const QString & | cacheDir | ) |
Sets the directory where cached files will be stored to cacheDir.
QNetworkDiskCache will create this directory if it does not exists.
Prepared cache items will be stored in the new cache directory when they are inserted.
Definition at line 148 of file qnetworkdiskcache.cpp.
void QNetworkDiskCache::setMaximumCacheSize | ( | qint64 | size | ) |
Sets the maximum size of the disk cache to be size in bytes.
If the new size is smaller then the current cache size then the cache will call expire().
Definition at line 501 of file qnetworkdiskcache.cpp.
|
virtual |
Reimplemented Function
Implements QAbstractNetworkCache.
Definition at line 453 of file qnetworkdiskcache.cpp.