src/qml/qml/qqmlnetworkaccessmanagerfactory.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qqmlnetworkaccessmanagerfactory.h"
  43
  44 QT_BEGIN_NAMESPACE
  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     The QtQuick 1 version of this class is named QDeclarativeNetworkAccessManagerFactory.
  84
  85     \sa {qml/networkaccessmanagerfactory}{NetworkAccessManagerFactory example}
  86 */
  87
  88 /*!
  89     Destroys the factory. The default implementation does nothing.
  90  */
  91 QQmlNetworkAccessManagerFactory::~QQmlNetworkAccessManagerFactory()
  92 {
  93 }
  94
  95 /*!
  96     \fn QNetworkAccessManager *QQmlNetworkAccessManagerFactory::create(QObject *parent)
  97
  98     Creates and returns a network access manager with the specified \a parent.
  99     This method must return a new QNetworkAccessManager instance each time
 100     it is called.
 101
 102     Note: this method may be called by multiple threads, so ensure the
 103     implementation of this method is reentrant.
 104 */
 105
 106 QT_END_NAMESPACE