blob: ed4fd340739a295d09a24bc0fe63000fbd86d906 (
plain)
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
|
// 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
#include "qqmlnetworkaccessmanagerfactory.h"
QT_BEGIN_NAMESPACE
#if QT_CONFIG(qml_network)
/*!
\class QQmlNetworkAccessManagerFactory
\since 5.0
\inmodule QtQml
\brief The QQmlNetworkAccessManagerFactory class creates QNetworkAccessManager instances for a QML engine.
A QML engine uses QNetworkAccessManager for all network access.
By implementing a factory, it is possible to provide the QML engine
with custom QNetworkAccessManager instances with specialized caching,
proxy and cookies support.
\list
\li The QNetworkDiskCache can be used as a request cache with \l {QNetworkDiskCache}.
\li Using \l {QNetworkProxy}, traffic sent by the QNetworkAccessManager can be tunnelled through a proxy.
\li Cookies can be saved for future requests by adding a \l {QNetworkCookieJar}.
\endlist
To implement a factory, subclass QQmlNetworkAccessManagerFactory and
implement the virtual create() method, then assign it to the relevant QML
engine using QQmlEngine::setNetworkAccessManagerFactory(). For instance, the QNetworkAccessManager
objects created by the following snippet will cache requests.
\snippet code/src_network_access_qnetworkaccessmanager.cpp 0
The factory can then be passed to the QML engine so it can instantiate the QNetworkAccessManager with the custom behavior.
\snippet code/src_network_access_qnetworkaccessmanager.cpp 1
Note the QML engine may create QNetworkAccessManager instances
from multiple threads. Because of this, the implementation of the create()
method must be \l{Reentrancy and Thread-Safety}{reentrant}. In addition,
the developer should be careful if the signals of the object to be
returned from create() are connected to the slots of an object that may
be created in a different thread:
\list
\li The QML engine internally handles all requests, and cleans up any
QNetworkReply objects it creates. Receiving the
QNetworkAccessManager::finished() signal in another thread may not
provide the receiver with a valid reply object if it has already
been deleted.
\li Authentication details provided to QNetworkAccessManager::authenticationRequired()
must be provided immediately, so this signal cannot be connected as a
Qt::QueuedConnection (or as the default Qt::AutoConnection from another
thread).
\endlist
For more information about signals and threads, see
\l {Threads and QObjects} and \l {Signals and Slots Across Threads}.
\sa QNetworkDiskCache
*/
/*!
Destroys the factory. The default implementation does nothing.
*/
QQmlNetworkAccessManagerFactory::~QQmlNetworkAccessManagerFactory()
{
}
/*!
\fn QNetworkAccessManager *QQmlNetworkAccessManagerFactory::create(QObject *parent)
Creates and returns a network access manager with the specified \a parent.
This method must return a new QNetworkAccessManager instance each time
it is called.
Note: this method may be called by multiple threads, so ensure the
implementation of this method is reentrant.
*/
#endif // qml_network
QT_END_NAMESPACE
|
