src/declarative/qml/qdeclarativenetworkaccessmanagerfactory.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qdeclarativenetworkaccessmanagerfactory.h"
  43
  44 QT_BEGIN_NAMESPACE
  45
  46 /*!
  47     \class QDeclarativeNetworkAccessManagerFactory
  48     \since 4.7
  49     \brief The QDeclarativeNetworkAccessManagerFactory class creates QNetworkAccessManager instances for a QML engine.
  50
  51     A QML engine uses QNetworkAccessManager for all network access.
  52     By implementing a factory, it is possible to provide the QML engine
  53     with custom QNetworkAccessManager instances with specialized caching,
  54     proxy and cookies support.
  55
  56     To implement a factory, subclass QDeclarativeNetworkAccessManagerFactory and
  57     implement the virtual create() method, then assign it to the relevant QML
  58     engine using QDeclarativeEngine::setNetworkAccessManagerFactory().
  59
  60     Note the QML engine may create QNetworkAccessManager instances
  61     from multiple threads. Because of this, the implementation of the create()
  62     method must be \l{Reentrancy and Thread-Safety}{reentrant}. In addition,
  63     the developer should be careful if the signals of the object to be
  64     returned from create() are connected to the slots of an object that may
  65     be created in a different thread:
  66
  67     \list
  68     \o The QML engine internally handles all requests, and cleans up any
  69        QNetworkReply objects it creates. Receiving the
  70        QNetworkAccessManager::finished() signal in another thread may not
  71        provide the receiver with a valid reply object if it has already
  72        been deleted.
  73     \o Authentication details provided to QNetworkAccessManager::authenticationRequired()
  74        must be provided immediately, so this signal cannot be connected as a
  75        Qt::QueuedConnection (or as the default Qt::AutoConnection from another
  76        thread).
  77     \endlist
  78
  79     For more information about signals and threads, see
  80     \l {Threads and QObjects} and \l {Signals and Slots Across Threads}.
  81
  82     \sa {declarative/cppextensions/networkaccessmanagerfactory}{NetworkAccessManagerFactory example}
  83 */
  84
  85 /*!
  86     Destroys the factory. The default implementation does nothing.
  87  */
  88 QDeclarativeNetworkAccessManagerFactory::~QDeclarativeNetworkAccessManagerFactory()
  89 {
  90 }
  91
  92 /*!
  93     \fn QNetworkAccessManager *QDeclarativeNetworkAccessManagerFactory::create(QObject *parent)
  94
  95     Creates and returns a network access manager with the specified \a parent.
  96     This method must return a new QNetworkAccessManager instance each time
  97     it is called.
  98
  99     Note: this method may be called by multiple threads, so ensure the
 100     implementation of this method is reentrant.
 101 */
 102
 103 QT_END_NAMESPACE