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 QtQml 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#include "qqmlnetworkaccessmanagerfactory.h"
41
42QT_BEGIN_NAMESPACE
43
44#if QT_CONFIG(qml_network)
45
46/*!
47 \class QQmlNetworkAccessManagerFactory
48 \since 5.0
49 \inmodule QtQml
50 \brief The QQmlNetworkAccessManagerFactory class creates QNetworkAccessManager instances for a QML engine.
51
52 A QML engine uses QNetworkAccessManager for all network access.
53 By implementing a factory, it is possible to provide the QML engine
54 with custom QNetworkAccessManager instances with specialized caching,
55 proxy and cookies support.
56
57 To implement a factory, subclass QQmlNetworkAccessManagerFactory and
58 implement the virtual create() method, then assign it to the relevant QML
59 engine using QQmlEngine::setNetworkAccessManagerFactory().
60
61 Note the QML engine may create QNetworkAccessManager instances
62 from multiple threads. Because of this, the implementation of the create()
63 method must be \l{Reentrancy and Thread-Safety}{reentrant}. In addition,
64 the developer should be careful if the signals of the object to be
65 returned from create() are connected to the slots of an object that may
66 be created in a different thread:
67
68 \list
69 \li The QML engine internally handles all requests, and cleans up any
70 QNetworkReply objects it creates. Receiving the
71 QNetworkAccessManager::finished() signal in another thread may not
72 provide the receiver with a valid reply object if it has already
73 been deleted.
74 \li Authentication details provided to QNetworkAccessManager::authenticationRequired()
75 must be provided immediately, so this signal cannot be connected as a
76 Qt::QueuedConnection (or as the default Qt::AutoConnection from another
77 thread).
78 \endlist
79
80 For more information about signals and threads, see
81 \l {Threads and QObjects} and \l {Signals and Slots Across Threads}.
82
83 \sa {C++ Extensions: Network Access Manager Factory Example}{Network Access Manager Factory Example}
84*/
85
86/*!
87 Destroys the factory. The default implementation does nothing.
88 */
89QQmlNetworkAccessManagerFactory::~QQmlNetworkAccessManagerFactory()
90{
91}
92
93/*!
94 \fn QNetworkAccessManager *QQmlNetworkAccessManagerFactory::create(QObject *parent)
95
96 Creates and returns a network access manager with the specified \a parent.
97 This method must return a new QNetworkAccessManager instance each time
98 it is called.
99
100 Note: this method may be called by multiple threads, so ensure the
101 implementation of this method is reentrant.
102*/
103
104#endif // qml_network
105
106QT_END_NAMESPACE
107