| 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 QtNetwork 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 | #ifndef QNETWORKSESSIONPRIVATE_H |
| 41 | #define QNETWORKSESSIONPRIVATE_H |
| 42 | |
| 43 | // |
| 44 | // W A R N I N G |
| 45 | // ------------- |
| 46 | // |
| 47 | // This file is not part of the Qt API. It exists purely as an |
| 48 | // implementation detail. This header file may change from version to |
| 49 | // version without notice, or even be removed. |
| 50 | // |
| 51 | // We mean it. |
| 52 | // |
| 53 | |
| 54 | #include <QtNetwork/private/qtnetworkglobal_p.h> |
| 55 | #include "qnetworksession.h" |
| 56 | #include "qnetworkconfiguration_p.h" |
| 57 | #include "QtCore/qsharedpointer.h" |
| 58 | |
| 59 | #ifndef QT_NO_BEARERMANAGEMENT |
| 60 | |
| 61 | QT_BEGIN_NAMESPACE |
| 62 | |
| 63 | class Q_NETWORK_EXPORT QNetworkSessionPrivate : public QObject |
| 64 | { |
| 65 | Q_OBJECT |
| 66 | |
| 67 | friend class QNetworkSession; |
| 68 | |
| 69 | public: |
| 70 | QNetworkSessionPrivate() : QObject(), |
| 71 | state(QNetworkSession::Invalid), isOpen(false) |
| 72 | {} |
| 73 | virtual ~QNetworkSessionPrivate() |
| 74 | {} |
| 75 | |
| 76 | //called by QNetworkSession constructor and ensures |
| 77 | //that the state is immediately updated (w/o actually opening |
| 78 | //a session). Also this function should take care of |
| 79 | //notification hooks to discover future state changes. |
| 80 | virtual void syncStateWithInterface() = 0; |
| 81 | |
| 82 | #ifndef QT_NO_NETWORKINTERFACE |
| 83 | virtual QNetworkInterface currentInterface() const = 0; |
| 84 | #endif |
| 85 | virtual QVariant sessionProperty(const QString &key) const = 0; |
| 86 | virtual void setSessionProperty(const QString &key, const QVariant &value) = 0; |
| 87 | |
| 88 | virtual void open() = 0; |
| 89 | virtual void close() = 0; |
| 90 | virtual void stop() = 0; |
| 91 | |
| 92 | virtual void setALREnabled(bool /*enabled*/) {} |
| 93 | virtual void migrate() = 0; |
| 94 | virtual void accept() = 0; |
| 95 | virtual void ignore() = 0; |
| 96 | virtual void reject() = 0; |
| 97 | |
| 98 | virtual QString errorString() const = 0; //must return translated string |
| 99 | virtual QNetworkSession::SessionError error() const = 0; |
| 100 | |
| 101 | virtual quint64 bytesWritten() const = 0; |
| 102 | virtual quint64 bytesReceived() const = 0; |
| 103 | virtual quint64 activeTime() const = 0; |
| 104 | |
| 105 | virtual QNetworkSession::UsagePolicies usagePolicies() const = 0; |
| 106 | virtual void setUsagePolicies(QNetworkSession::UsagePolicies) = 0; |
| 107 | |
| 108 | static void setUsagePolicies(QNetworkSession&, QNetworkSession::UsagePolicies); //for unit testing |
| 109 | protected: |
| 110 | inline QNetworkConfigurationPrivatePointer privateConfiguration(const QNetworkConfiguration &config) const |
| 111 | { |
| 112 | return config.d; |
| 113 | } |
| 114 | |
| 115 | inline void setPrivateConfiguration(QNetworkConfiguration &config, |
| 116 | const QNetworkConfigurationPrivatePointer &ptr) const |
| 117 | { |
| 118 | config.d = ptr; |
| 119 | } |
| 120 | |
| 121 | Q_SIGNALS: |
| 122 | //releases any pending waitForOpened() calls |
| 123 | void quitPendingWaitsForOpened(); |
| 124 | |
| 125 | void error(QNetworkSession::SessionError error); |
| 126 | void stateChanged(QNetworkSession::State state); |
| 127 | void closed(); |
| 128 | void newConfigurationActivated(); |
| 129 | void preferredConfigurationChanged(const QNetworkConfiguration &config, bool isSeamless); |
| 130 | void usagePoliciesChanged(QNetworkSession::UsagePolicies); |
| 131 | |
| 132 | protected: |
| 133 | QNetworkSession *q; |
| 134 | |
| 135 | // The config set on QNetworkSession. |
| 136 | QNetworkConfiguration publicConfig; |
| 137 | |
| 138 | // If publicConfig is a ServiceNetwork this is a copy of publicConfig. |
| 139 | // If publicConfig is an UserChoice that is resolved to a ServiceNetwork this is the actual |
| 140 | // ServiceNetwork configuration. |
| 141 | QNetworkConfiguration serviceConfig; |
| 142 | |
| 143 | // This is the actual active configuration currently in use by the session. |
| 144 | // Either a copy of publicConfig or one of serviceConfig.children(). |
| 145 | QNetworkConfiguration activeConfig; |
| 146 | |
| 147 | QNetworkSession::State state; |
| 148 | bool isOpen; |
| 149 | |
| 150 | QRecursiveMutex mutex; |
| 151 | }; |
| 152 | |
| 153 | QT_END_NAMESPACE |
| 154 | |
| 155 | #endif // QT_NO_BEARERMANAGEMENT |
| 156 | |
| 157 | #endif // QNETWORKSESSIONPRIVATE_H |
| 158 | |