1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qqmlnetworkaccessmanagerfactory.h"
47 \class QQmlNetworkAccessManagerFactory
50 \brief The QQmlNetworkAccessManagerFactory class creates QNetworkAccessManager instances for a QML engine.
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.
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().
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:
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
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
80 For more information about signals and threads, see
81 \l {Threads and QObjects} and \l {Signals and Slots Across Threads}.
83 The QtQuick 1 version of this class is named QDeclarativeNetworkAccessManagerFactory.
85 \sa {qml/cppextensions/networkaccessmanagerfactory}{NetworkAccessManagerFactory example}
89 Destroys the factory. The default implementation does nothing.
91 QQmlNetworkAccessManagerFactory::~QQmlNetworkAccessManagerFactory()
96 \fn QNetworkAccessManager *QQmlNetworkAccessManagerFactory::create(QObject *parent)
98 Creates and returns a network access manager with the specified \a parent.
99 This method must return a new QNetworkAccessManager instance each time
102 Note: this method may be called by multiple threads, so ensure the
103 implementation of this method is reentrant.