qabstractnetworkcache.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#ifndef QABSTRACTNETWORKCACHE_H
#define QABSTRACTNETWORKCACHE_H
 
#include <QtNetwork/qtnetworkglobal.h>
#include <QtCore/qobject.h>
#include <QtCore/qshareddata.h>
#include <QtCore/qpair.h>
#include <QtNetwork/qnetworkrequest.h>
 
QT_BEGIN_NAMESPACE
 
 
class QIODevice;
class QDateTime;
class QUrl;
 
class QNetworkCacheMetaDataPrivate;
class Q_NETWORK_EXPORT QNetworkCacheMetaData
{
 
public:
    typedef QPair<QByteArray, QByteArray> RawHeader;
    typedef QList<RawHeader> RawHeaderList;
    typedef QHash<QNetworkRequest::Attribute, QVariant> AttributesMap;
 
    QNetworkCacheMetaData();
    QNetworkCacheMetaData(const QNetworkCacheMetaData &other);
    ~QNetworkCacheMetaData();
 
    QNetworkCacheMetaData &operator=(QNetworkCacheMetaData &&other) noexcept { swap(other); return *this; }
    QNetworkCacheMetaData &operator=(const QNetworkCacheMetaData &other);
 
    void swap(QNetworkCacheMetaData &other) noexcept
    { d.swap(other.d); }
 
    bool operator==(const QNetworkCacheMetaData &other) const;
    inline bool operator!=(const QNetworkCacheMetaData &other) const
        { return !(*this == other); }
 
    bool isValid() const;
 
    QUrl url() const;
    void setUrl(const QUrl &url);
 
    RawHeaderList rawHeaders() const;
    void setRawHeaders(const RawHeaderList &headers);
 
    QHttpHeaders headers() const;
    void setHeaders(const QHttpHeaders &headers);
 
    QDateTime lastModified() const;
    void setLastModified(const QDateTime &dateTime);
 
    QDateTime expirationDate() const;
    void setExpirationDate(const QDateTime &dateTime);
 
    bool saveToDisk() const;
    void setSaveToDisk(bool allow);
 
    AttributesMap attributes() const;
    void setAttributes(const AttributesMap &attributes);
 
private:
    friend class QNetworkCacheMetaDataPrivate;
    QSharedDataPointer<QNetworkCacheMetaDataPrivate> d;
};
 
Q_DECLARE_SHARED(QNetworkCacheMetaData)
 
Q_NETWORK_EXPORT QDataStream &operator<<(QDataStream &, const QNetworkCacheMetaData &);
Q_NETWORK_EXPORT QDataStream &operator>>(QDataStream &, QNetworkCacheMetaData &);
 
 
class QAbstractNetworkCachePrivate;
class Q_NETWORK_EXPORT QAbstractNetworkCache : public QObject
{
    Q_OBJECT
 
public:
    virtual ~QAbstractNetworkCache();
 
    virtual QNetworkCacheMetaData metaData(const QUrl &url) = 0;
    virtual void updateMetaData(const QNetworkCacheMetaData &metaData) = 0;
    virtual QIODevice *data(const QUrl &url) = 0;
    virtual bool remove(const QUrl &url) = 0;
    virtual qint64 cacheSize() const = 0;
 
    virtual QIODevice *prepare(const QNetworkCacheMetaData &metaData) = 0;
    virtual void insert(QIODevice *device) = 0;
 
public Q_SLOTS:
    virtual void clear() = 0;
 
protected:
    explicit QAbstractNetworkCache(QObject *parent = nullptr);
    QAbstractNetworkCache(QAbstractNetworkCachePrivate &dd, QObject *parent);
 
private:
    Q_DECLARE_PRIVATE(QAbstractNetworkCache)
    Q_DISABLE_COPY(QAbstractNetworkCache)
};
 
QT_END_NAMESPACE
 
#endif