1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QNETWORKACCESSBACKEND_P_H
#define QNETWORKACCESSBACKEND_P_H
#include <QtNetwork/qtnetworkglobal.h>
#include <QtNetwork/qnetworkrequest.h>
#include <QtNetwork/qnetworkaccessmanager.h>
#include <QtNetwork/qnetworkreply.h>
#include <QtCore/qobject.h>
#include <QtCore/qflags.h>
#include <QtCore/qbytearrayview.h>
#if QT_CONFIG(ssl)
#include <QtNetwork/qsslconfiguration.h>
#endif
QT_BEGIN_NAMESPACE
class QNetworkReplyImplPrivate;
class QNetworkAccessManagerPrivate;
class QNetworkAccessBackendPrivate;
class Q_NETWORK_EXPORT QNetworkAccessBackend : public QObject
{
Q_OBJECT
Q_DECLARE_PRIVATE(QNetworkAccessBackend);
public:
enum class TargetType {
Networked = 0x1, // We need to query for proxy in case it is needed
Local = 0x2, // Local file, generated data or local device
};
Q_ENUM(TargetType)
Q_DECLARE_FLAGS(TargetTypes, TargetType)
enum class SecurityFeature {
None = 0x0,
TLS = 0x1, // We need to set QSslConfiguration
};
Q_ENUM(SecurityFeature)
Q_DECLARE_FLAGS(SecurityFeatures, SecurityFeature)
enum class IOFeature {
None = 0x0,
ZeroCopy = 0x1, // readPointer and advanceReadPointer() is available!
NeedResetableUpload = 0x2, // Need to buffer upload data
SupportsSynchronousMode = 0x4, // Used for XMLHttpRequest
};
Q_ENUM(IOFeature)
Q_DECLARE_FLAGS(IOFeatures, IOFeature)
QNetworkAccessBackend(TargetTypes targetTypes, SecurityFeatures securityFeatures,
IOFeatures ioFeatures);
QNetworkAccessBackend(TargetTypes targetTypes);
QNetworkAccessBackend(TargetTypes targetTypes, SecurityFeatures securityFeatures);
QNetworkAccessBackend(TargetTypes targetTypes, IOFeatures ioFeatures);
virtual ~QNetworkAccessBackend();
SecurityFeatures securityFeatures() const noexcept;
TargetTypes targetTypes() const noexcept;
IOFeatures ioFeatures() const noexcept;
inline bool needsResetableUploadData() const noexcept
{
return ioFeatures() & IOFeature::NeedResetableUpload;
}
virtual bool start();
virtual void open() = 0;
virtual void close() = 0;
#if QT_CONFIG(ssl)
virtual void setSslConfiguration(const QSslConfiguration &configuration);
virtual QSslConfiguration sslConfiguration() const;
#endif
virtual void ignoreSslErrors();
virtual void ignoreSslErrors(const QList<QSslError> &errors);
virtual qint64 bytesAvailable() const = 0;
virtual QByteArrayView readPointer();
virtual void advanceReadPointer(qint64 distance);
virtual qint64 read(char *data, qint64 maxlen);
virtual bool wantToRead();
#if QT_CONFIG(networkproxy)
QList<QNetworkProxy> proxyList() const;
#endif
QUrl url() const;
void setUrl(const QUrl &url);
QVariant header(QNetworkRequest::KnownHeaders header) const;
void setHeader(QNetworkRequest::KnownHeaders header, const QVariant &value);
QByteArray rawHeader(const QByteArray &header) const;
void setRawHeader(const QByteArray &header, const QByteArray &value);
QNetworkAccessManager::Operation operation() const;
bool isCachingEnabled() const;
void setCachingEnabled(bool canCache);
void setAttribute(QNetworkRequest::Attribute attribute, const QVariant &value);
QIODevice *createUploadByteDevice();
QIODevice *uploadByteDevice();
QAbstractNetworkCache *networkCache() const;
public slots:
void readyRead();
protected slots:
void finished();
void error(QNetworkReply::NetworkError code, const QString &errorString);
#ifndef QT_NO_NETWORKPROXY
void proxyAuthenticationRequired(const QNetworkProxy &proxy, QAuthenticator *auth);
#endif
void authenticationRequired(QAuthenticator *auth);
void metaDataChanged();
void redirectionRequested(const QUrl &destination);
private:
void setReplyPrivate(QNetworkReplyImplPrivate *reply);
void setManagerPrivate(QNetworkAccessManagerPrivate *manager);
bool isSynchronous() const;
void setSynchronous(bool synchronous);
friend class QNetworkAccessManager; // for setReplyPrivate
friend class QNetworkAccessManagerPrivate; // for setManagerPrivate
friend class QNetworkReplyImplPrivate; // for {set,is}Synchronous()
};
class Q_NETWORK_EXPORT QNetworkAccessBackendFactory : public QObject
{
Q_OBJECT
public:
QNetworkAccessBackendFactory();
virtual ~QNetworkAccessBackendFactory();
virtual QStringList supportedSchemes() const = 0;
virtual QNetworkAccessBackend *create(QNetworkAccessManager::Operation op,
const QNetworkRequest &request) const = 0;
};
#define QNetworkAccessBackendFactory_iid "org.qt-project.Qt.NetworkAccessBackendFactory"
Q_DECLARE_INTERFACE(QNetworkAccessBackendFactory, QNetworkAccessBackendFactory_iid);
QT_END_NAMESPACE
#endif
|
