-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgsnetworkaccessmanager.sip.in
407 lines (281 loc) · 13.2 KB
/
qgsnetworkaccessmanager.sip.in
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsnetworkaccessmanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsNetworkRequestParameters
{
%Docstring
Encapsulates parameters and properties of a network request.
.. versionadded:: 3.6
%End
%TypeHeaderCode
#include "qgsnetworkaccessmanager.h"
%End
public:
enum RequestAttributes
{
AttributeInitiatorClass,
AttributeInitiatorRequestId,
};
QgsNetworkRequestParameters();
%Docstring
Default constructor.
%End
QgsNetworkRequestParameters( QNetworkAccessManager::Operation operation,
const QNetworkRequest &request,
int requestId,
const QByteArray &content = QByteArray() );
%Docstring
Constructor for QgsNetworkRequestParameters, with the specified network
``operation`` and original ``request``.
%End
QNetworkAccessManager::Operation operation() const;
%Docstring
Returns the request operation, e.g. GET or POST.
%End
QNetworkRequest request() const;
%Docstring
Returns the network request.
This is the original network request sent to :py:class:`QgsNetworkAccessManager`, but with QGIS specific
configuration options such as proxy handling and SSL exceptions applied.
%End
QString originatingThreadId() const;
%Docstring
Returns a string identifying the thread which the request originated from.
%End
int requestId() const;
%Docstring
Returns a unique ID identifying the request.
%End
QByteArray content() const;
%Docstring
Returns the request's content. This is only used for POST or PUT operation
requests.
%End
QString initiatorClassName() const;
%Docstring
Returns the class name of the object which initiated this request.
This is only available for QNetworkRequests which have had the
QgsNetworkRequestParameters.AttributeInitiatorClass attribute set.
.. seealso:: :py:func:`initiatorRequestId`
%End
QVariant initiatorRequestId() const;
%Docstring
Returns the internal ID used by the object which initiated this request to identify
individual requests.
This is only available for QNetworkRequests which have had the
QgsNetworkRequestParameters.AttributeInitiatorRequestId attribute set.
.. seealso:: :py:func:`initiatorClassName`
%End
};
class QgsNetworkAccessManager : QNetworkAccessManager
{
%Docstring
network access manager for QGIS
This class implements the QGIS network access manager. It's a singleton
that can be used across QGIS.
Plugins can insert proxy factories and thereby redirect requests to
individual proxies.
If no proxy factories are there or none returns a proxy for an URL a
fallback proxy can be set. There's also a exclude list that defines URLs
that the fallback proxy should not be used for, then no proxy will be used.
.. versionadded:: 1.5
%End
%TypeHeaderCode
#include "qgsnetworkaccessmanager.h"
%End
public:
static QgsNetworkAccessManager *instance( Qt::ConnectionType connectionType = Qt::BlockingQueuedConnection );
%Docstring
Returns a pointer to the active QgsNetworkAccessManager
for the current thread.
With the ``connectionType`` parameter it is possible to setup the default connection
type that is used to handle signals that might require user interaction and therefore
need to be handled on the main thread. See in-depth discussion below.
:param connectionType: In most cases the default of using a ``Qt.BlockingQueuedConnection``
is ok, to make a background thread wait for the main thread to answer such a request is
fine and anything else is dangerous.
However, in case the request was started on the main thread, one should execute a
local event loop in a helper thread and freeze the main thread for the duration of the
download. In this case, if an authentication request is sent from the background thread
network access manager, the background thread should be blocked, the main thread be woken
up, processEvents() executed once, the main thread frozen again and the background thread
continued.
%End
QgsNetworkAccessManager( QObject *parent = 0 );
void insertProxyFactory( QNetworkProxyFactory *factory /Transfer/ );
%Docstring
Inserts a ``factory`` into the proxy factories list.
Ownership of ``factory`` is transferred to the manager.
.. seealso:: :py:func:`removeProxyFactory`
.. seealso:: :py:func:`proxyFactories`
%End
void removeProxyFactory( QNetworkProxyFactory *factory /TransferBack/ );
%Docstring
Removes a ``factory`` from the proxy factories list.
.. seealso:: :py:func:`insertProxyFactory`
.. seealso:: :py:func:`proxyFactories`
%End
const QList<QNetworkProxyFactory *> proxyFactories() const;
%Docstring
Returns a list of proxy factories used by the manager.
.. seealso:: :py:func:`insertProxyFactory`
.. seealso:: :py:func:`proxyFactories`
%End
const QNetworkProxy &fallbackProxy() const;
%Docstring
Returns the fallback proxy used by the manager.
The fallback proxy is used for URLs which no other proxy factory returned proxies for.
.. seealso:: :py:func:`proxyFactories`
.. seealso:: :py:func:`setFallbackProxyAndExcludes`
%End
QStringList excludeList() const;
%Docstring
Returns the proxy exclude list.
This list consists of the beginning of URL strings which will not use the fallback proxy.
.. seealso:: :py:func:`fallbackProxy`
.. seealso:: :py:func:`setFallbackProxyAndExcludes`
%End
void setFallbackProxyAndExcludes( const QNetworkProxy &proxy, const QStringList &excludes );
%Docstring
Sets the fallback ``proxy`` and URLs which shouldn't use it.
The fallback proxy is used for URLs which no other proxy factory returned proxies for.
The ``excludes`` list specifies the beginning of URL strings which will not use this fallback proxy.
.. seealso:: :py:func:`fallbackProxy`
.. seealso:: :py:func:`excludeList`
%End
static QString cacheLoadControlName( QNetworkRequest::CacheLoadControl control );
%Docstring
Returns the name for QNetworkRequest.CacheLoadControl.
.. seealso:: :py:func:`cacheLoadControlFromName`
%End
static QNetworkRequest::CacheLoadControl cacheLoadControlFromName( const QString &name );
%Docstring
Returns QNetworkRequest.CacheLoadControl from a ``name``.
.. seealso:: :py:func:`cacheLoadControlName`
%End
void setupDefaultProxyAndCache( Qt::ConnectionType connectionType = Qt::BlockingQueuedConnection );
%Docstring
Setup the QgsNetworkAccessManager (NAM) according to the user's settings.
The ``connectionType`` sets up the default connection type that is used to
handle signals that might require user interaction and therefore
need to be handled on the main thread. See in-depth discussion in the documentation
for the constructor of this class.
%End
bool useSystemProxy() const;
%Docstring
Returns whether the system proxy should be used.
%End
static int timeout();
%Docstring
Returns the network timeout length, in milliseconds.
.. seealso:: :py:func:`setTimeout`
.. versionadded:: 3.6
%End
static void setTimeout( int time );
%Docstring
Sets the maximum timeout ``time`` for network requests, in milliseconds.
.. seealso:: :py:func:`timeout`
.. versionadded:: 3.6
%End
signals:
void requestAboutToBeCreated( QNetworkAccessManager::Operation, const QNetworkRequest &, QIODevice * ) /Deprecated/;
%Docstring
.. deprecated:: Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead.
%End
void requestAboutToBeCreated( QgsNetworkRequestParameters request );
%Docstring
Emitted when a network request is about to be created.
This signal is propagated to the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about requests
created in any thread.
.. seealso:: :py:func:`finished`
.. seealso:: :py:func:`requestTimedOut`
.. versionadded:: 3.6
%End
void finished( QgsNetworkReplyContent reply );
%Docstring
This signal is emitted whenever a pending network reply is finished.
The ``reply`` parameter will contain a QgsNetworkReplyContent object, containing all the useful
information relating to the reply, including headers and reply content.
This signal is propagated to the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about requests
created in any thread.
.. seealso:: :py:func:`requestAboutToBeCreated`
.. seealso:: :py:func:`requestTimedOut`
.. versionadded:: 3.6
%End
void requestTimedOut( QgsNetworkRequestParameters request );
%Docstring
Emitted when a network request has timed out.
This signal is propagated to the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about requests
created in any thread.
.. seealso:: :py:func:`requestAboutToBeCreated`
.. seealso:: :py:func:`finished`
.. versionadded:: 3.6
%End
void downloadProgress( int requestId, qint64 bytesReceived, qint64 bytesTotal );
%Docstring
Emitted when a network reply receives a progress report.
The ``requestId`` argument reflects the unique ID identifying the original request which the progress report relates to.
The ``bytesReceived`` parameter indicates the number of bytes received, while ``bytesTotal`` indicates the total number
of bytes expected to be downloaded. If the number of bytes to be downloaded is not known, ``bytesTotal`` will be -1.
This signal is propagated to the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about requests
created in any thread.
.. versionadded:: 3.6
%End
void requestRequiresAuth( int requestId, const QString &realm );
%Docstring
Emitted when a network request prompts an authentication request.
The ``requestId`` argument reflects the unique ID identifying the original request which the authentication relates to.
This signal is propagated to the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about authentication requests
from any thread.
This signal is for debugging and logging purposes only, and cannot be used to respond to the
requests. See QgsNetworkAuthenticationHandler for details on how to handle authentication requests.
.. seealso:: :py:func:`requestAuthDetailsAdded`
.. versionadded:: 3.6
%End
void requestAuthDetailsAdded( int requestId, const QString &realm, const QString &user, const QString &password );
%Docstring
Emitted when network authentication details have been added to a request.
The ``requestId`` argument reflects the unique ID identifying the original request which the authentication relates to.
This signal is always sent from the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about authentication requests
from any thread.
This signal is for debugging and logging purposes only, and should not be used to respond to the
requests. See QgsNetworkAuthenticationHandler for details on how to handle authentication requests.
.. seealso:: :py:func:`requestRequiresAuth`
.. versionadded:: 3.6
%End
void requestEncounteredSslErrors( int requestId, const QList<QSslError> &errors );
%Docstring
Emitted when a network request encounters SSL ``errors``.
The ``requestId`` argument reflects the unique ID identifying the original request which the SSL error relates to.
This signal is propagated to the main thread QgsNetworkAccessManager instance, so it is necessary
only to connect to the main thread's signal in order to receive notifications about SSL errors
from any thread.
This signal is for debugging and logging purposes only, and cannot be used to respond to the errors.
See QgsSslErrorHandler for details on how to handle SSL errors and potentially ignore them.
.. versionadded:: 3.6
%End
void requestCreated( QNetworkReply * ) /Deprecated/;
%Docstring
.. deprecated:: Use the thread-safe requestAboutToBeCreated( QgsNetworkRequestParameters ) signal instead.
%End
void requestTimedOut( QNetworkReply * );
protected:
virtual QNetworkReply *createRequest( QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *outgoingData = 0 );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsnetworkaccessmanager.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/