CopperSpice API  1.7.2
QNetworkCacheMetaData Class Reference

The QNetworkCacheMetaData class provides cache information. More...

Public Typedefs

typedef QHash< QNetworkRequest::Attribute, QVariantAttributesMap
 
typedef QPair< QByteArray, QByteArrayRawHeader
 
typedef QList< RawHeaderRawHeaderList
 

Public Methods

 QNetworkCacheMetaData ()
 
 QNetworkCacheMetaData (const QNetworkCacheMetaData &other)
 
 ~QNetworkCacheMetaData ()
 
AttributesMap attributes () const
 
QDateTime expirationDate () const
 
bool isValid () const
 
QDateTime lastModified () const
 
bool operator!= (const QNetworkCacheMetaData &other) const
 
QNetworkCacheMetaData & operator= (const QNetworkCacheMetaData &other)
 
QNetworkCacheMetaData & operator= (QNetworkCacheMetaData &&other)
 
bool operator== (const QNetworkCacheMetaData &other) const
 
RawHeaderList rawHeaders () const
 
bool saveToDisk () const
 
void setAttributes (const AttributesMap &attributes)
 
void setExpirationDate (const QDateTime &dateTime)
 
void setLastModified (const QDateTime &dateTime)
 
void setRawHeaders (const RawHeaderList &list)
 
void setSaveToDisk (bool allow)
 
void setUrl (const QUrl &url)
 
void swap (QNetworkCacheMetaData &other)
 
QUrl url () const
 

Related Functions

These are not member functions

QDataStreamoperator<< (QDataStream &out, const QNetworkCacheMetaData &metaData)
 
QDataStreamoperator>> (QDataStream &in, QNetworkCacheMetaData &metaData)
 

Detailed Description

The QNetworkCacheMetaData class provides cache information. QNetworkCacheMetaData provides information about a cache file including the url, when it was last modified, when the cache file was created, headers for file and if the file should be saved onto a disk.

See also
QAbstractNetworkCache

Member Typedef Documentation

Constructor & Destructor Documentation

QNetworkCacheMetaData::QNetworkCacheMetaData ( )

Constructs an invalid network cache meta data.

See also
isValid()
QNetworkCacheMetaData::QNetworkCacheMetaData ( const QNetworkCacheMetaData &  other)

Constructs a copy of the other QNetworkCacheMetaData.

QNetworkCacheMetaData::~QNetworkCacheMetaData ( )

Destroys the network cache meta data.

Method Documentation

AttributesMap QNetworkCacheMetaData::attributes ( ) const

Returns all the attributes stored with this cache item.

See also
setAttributes(), QNetworkRequest::Attribute
QDateTime QNetworkCacheMetaData::expirationDate ( ) const

Returns the date and time when the meta data expires.

See also
setExpirationDate()
bool QNetworkCacheMetaData::isValid ( ) const

Returns true if this network cache meta data has attributes that have been set otherwise false.

QDateTime QNetworkCacheMetaData::lastModified ( ) const

Returns the date and time when the meta data was last modified.

See also
setLastModified()
bool QNetworkCacheMetaData::operator!= ( const QNetworkCacheMetaData &  other) const
inline

Returns true if this meta data is not equal to the other meta data, otherwise returns false.

See also
operator==()
QNetworkCacheMetaData & QNetworkCacheMetaData::operator= ( const QNetworkCacheMetaData &  other)

Copy assigns from other and returns a reference to this object.

QNetworkCacheMetaData & QNetworkCacheMetaData::operator= ( QNetworkCacheMetaData &&  other)
inline

Move assigns from other and returns a reference to this object.

bool QNetworkCacheMetaData::operator== ( const QNetworkCacheMetaData &  other) const

Returns true if this meta data is equal to the other meta data, otherwise returns false.

See also
operator!=()
RawHeaderList QNetworkCacheMetaData::rawHeaders ( ) const

Returns a list of all raw headers that are set in this meta data. The list is in the same order that the headers were set.

See also
setRawHeaders()
bool QNetworkCacheMetaData::saveToDisk ( ) const

Returns is this cache should be allowed to be stored on disk.

Some cache implementations can keep these cache items in memory for performance reasons, but for security reasons they should not be written to disk.

Specifically with http, documents marked with Pragma: no-cache, or have a Cache-control set to no-store or no-cache or any https document that does not have "Cache-control: public" set will set the saveToDisk to false.

See also
setSaveToDisk()
void QNetworkCacheMetaData::setAttributes ( const AttributesMap attributes)

Sets all attributes of this cache item to be the map attributes.

See also
attributes(), QNetworkRequest::setAttribute()
void QNetworkCacheMetaData::setExpirationDate ( const QDateTime dateTime)

Sets the date and time when the meta data expires to dateTime.

See also
expirationDate()
void QNetworkCacheMetaData::setLastModified ( const QDateTime dateTime)

Sets the date and time when the meta data was last modified to dateTime.

See also
lastModified()
void QNetworkCacheMetaData::setRawHeaders ( const RawHeaderList list)

Sets the raw headers to list.

See also
rawHeaders()
void QNetworkCacheMetaData::setSaveToDisk ( bool  allow)

Sets whether this network cache meta data and associated content should be allowed to be stored on disk to allow.

See also
saveToDisk()
void QNetworkCacheMetaData::setUrl ( const QUrl url)

Sets the URL this network cache meta data to to be url. The password and fragment are removed from the url.

See also
url()
void QNetworkCacheMetaData::swap ( QNetworkCacheMetaData &  other)
inline

Swaps this metadata instance with other. This method is very fast and never fails.

QUrl QNetworkCacheMetaData::url ( ) const

Returns the URL this network cache meta data is referring to.

See also
setUrl()

Friends And Related Function Documentation

QDataStream & operator<< ( QDataStream out,
const QNetworkCacheMetaData &  metaData 
)
related

Writes metaData to the out stream.

See also
Refer to Serializing Data Types for additional information
QDataStream & operator>> ( QDataStream in,
QNetworkCacheMetaData &  metaData 
)
related

Reads a QNetworkCacheMetaData from the stream in into metaData.

See also
Refer to Serializing Data Types for additional information