com.trolltech.qt.network
Class QAbstractNetworkCache

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.core.QObject
                  extended by com.trolltech.qt.network.QAbstractNetworkCache
All Implemented Interfaces:
QtJambiInterface
Direct Known Subclasses:
QNetworkDiskCache

public abstract class QAbstractNetworkCache
extends QObject

The QAbstractNetworkCache class provides the interface for cache implementations. 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.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
protected QAbstractNetworkCache()
          Constructs an abstract network cache with the given parent.
protected QAbstractNetworkCache(QObject parent)
          Constructs an abstract network cache with the given parent.
 
Method Summary
abstract  long cacheSize()
          Returns the current size taken up by the cache.
abstract  void clear()
          Removes all items from the cache.
abstract  QIODevice data(QUrl url)
          Returns the data associated with url.
abstract  void insert(QIODevice device)
          Inserts the data in device and the prepared meta data into the cache.
abstract  QNetworkCacheMetaData metaData(QUrl url)
          Returns the meta data for the url url.
abstract  QIODevice prepare(QNetworkCacheMetaData metaData)
          Returns the device that should be populated with the data for the cache item metaData.
abstract  boolean remove(QUrl url)
          Removes the cache entry for url, returning true if success otherwise false.
abstract  void updateMetaData(QNetworkCacheMetaData metaData)
          Updates the cache meta date for the metaData's url to metaData
 
Methods inherited from class com.trolltech.qt.core.QObject
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QAbstractNetworkCache

protected QAbstractNetworkCache()
Constructs an abstract network cache with the given parent.


QAbstractNetworkCache

protected QAbstractNetworkCache(QObject parent)
Constructs an abstract network cache with the given parent.

Method Detail

cacheSize

public abstract long cacheSize()
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().


clear

public abstract void clear()
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(), and remove().


data

public abstract QIODevice data(QUrl url)
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(), and prepare().


insert

public abstract void insert(QIODevice device)
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(), and remove().


metaData

public abstract QNetworkCacheMetaData metaData(QUrl url)
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(), and data().


prepare

public abstract QIODevice prepare(QNetworkCacheMetaData metaData)
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(), and insert().


remove

public abstract boolean remove(QUrl url)
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(), and prepare().


updateMetaData

public abstract void updateMetaData(QNetworkCacheMetaData metaData)
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(), and prepare().