1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNetwork module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QABSTRACTNETWORKCACHE_H
41#define QABSTRACTNETWORKCACHE_H
42
43#include <QtNetwork/qtnetworkglobal.h>
44#include <QtCore/qobject.h>
45#include <QtCore/qshareddata.h>
46#include <QtCore/qpair.h>
47#include <QtNetwork/qnetworkrequest.h>
48
49QT_BEGIN_NAMESPACE
50
51
52class QIODevice;
53class QDateTime;
54class QUrl;
55template<class T> class QList;
56
57class QNetworkCacheMetaDataPrivate;
58class Q_NETWORK_EXPORT QNetworkCacheMetaData
59{
60
61public:
62 typedef QPair<QByteArray, QByteArray> RawHeader;
63 typedef QList<RawHeader> RawHeaderList;
64 typedef QHash<QNetworkRequest::Attribute, QVariant> AttributesMap;
65
66 QNetworkCacheMetaData();
67 QNetworkCacheMetaData(const QNetworkCacheMetaData &other);
68 ~QNetworkCacheMetaData();
69
70 QNetworkCacheMetaData &operator=(QNetworkCacheMetaData &&other) noexcept { swap(other); return *this; }
71 QNetworkCacheMetaData &operator=(const QNetworkCacheMetaData &other);
72
73 void swap(QNetworkCacheMetaData &other) noexcept
74 { qSwap(d, other.d); }
75
76 bool operator==(const QNetworkCacheMetaData &other) const;
77 inline bool operator!=(const QNetworkCacheMetaData &other) const
78 { return !(*this == other); }
79
80 bool isValid() const;
81
82 QUrl url() const;
83 void setUrl(const QUrl &url);
84
85 RawHeaderList rawHeaders() const;
86 void setRawHeaders(const RawHeaderList &headers);
87
88 QDateTime lastModified() const;
89 void setLastModified(const QDateTime &dateTime);
90
91 QDateTime expirationDate() const;
92 void setExpirationDate(const QDateTime &dateTime);
93
94 bool saveToDisk() const;
95 void setSaveToDisk(bool allow);
96
97 AttributesMap attributes() const;
98 void setAttributes(const AttributesMap &attributes);
99
100private:
101 friend class QNetworkCacheMetaDataPrivate;
102 QSharedDataPointer<QNetworkCacheMetaDataPrivate> d;
103};
104
105Q_DECLARE_SHARED(QNetworkCacheMetaData)
106
107Q_NETWORK_EXPORT QDataStream &operator<<(QDataStream &, const QNetworkCacheMetaData &);
108Q_NETWORK_EXPORT QDataStream &operator>>(QDataStream &, QNetworkCacheMetaData &);
109
110
111class QAbstractNetworkCachePrivate;
112class Q_NETWORK_EXPORT QAbstractNetworkCache : public QObject
113{
114 Q_OBJECT
115
116public:
117 virtual ~QAbstractNetworkCache();
118
119 virtual QNetworkCacheMetaData metaData(const QUrl &url) = 0;
120 virtual void updateMetaData(const QNetworkCacheMetaData &metaData) = 0;
121 virtual QIODevice *data(const QUrl &url) = 0;
122 virtual bool remove(const QUrl &url) = 0;
123 virtual qint64 cacheSize() const = 0;
124
125 virtual QIODevice *prepare(const QNetworkCacheMetaData &metaData) = 0;
126 virtual void insert(QIODevice *device) = 0;
127
128public Q_SLOTS:
129 virtual void clear() = 0;
130
131protected:
132 explicit QAbstractNetworkCache(QObject *parent = nullptr);
133 QAbstractNetworkCache(QAbstractNetworkCachePrivate &dd, QObject *parent);
134
135private:
136 Q_DECLARE_PRIVATE(QAbstractNetworkCache)
137 Q_DISABLE_COPY(QAbstractNetworkCache)
138};
139
140QT_END_NAMESPACE
141
142#endif
143