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 QNETWORKSESSION_H
41#define QNETWORKSESSION_H
42
43#include <QtNetwork/qtnetworkglobal.h>
44#include <QtCore/qobject.h>
45#include <QtCore/qstring.h>
46#include <QtNetwork/qnetworkinterface.h>
47#include <QtCore/qvariant.h>
48#include <QtNetwork/qnetworkconfiguration.h>
49
50#ifndef QT_NO_BEARERMANAGEMENT
51
52#if defined(Q_OS_WIN) && defined(interface)
53#undef interface
54#endif
55
56#include <QtCore/qshareddata.h>
57QT_BEGIN_NAMESPACE
58
59class QNetworkSessionPrivate;
60class Q_NETWORK_EXPORT QNetworkSession : public QObject
61{
62 Q_OBJECT
63
64public:
65 enum State {
66 Invalid = 0,
67 NotAvailable,
68 Connecting,
69 Connected,
70 Closing,
71 Disconnected,
72 Roaming
73 };
74
75 enum SessionError {
76 UnknownSessionError = 0,
77 SessionAbortedError,
78 RoamingError,
79 OperationNotSupportedError,
80 InvalidConfigurationError
81 };
82
83 enum UsagePolicy {
84 NoPolicy = 0,
85 NoBackgroundTrafficPolicy = 1
86 };
87
88 Q_DECLARE_FLAGS(UsagePolicies, UsagePolicy)
89
90 explicit QNetworkSession(const QNetworkConfiguration &connConfig, QObject *parent = nullptr);
91 virtual ~QNetworkSession();
92
93 bool isOpen() const;
94 QNetworkConfiguration configuration() const;
95#ifndef QT_NO_NETWORKINTERFACE
96 QNetworkInterface interface() const;
97#endif
98
99 State state() const;
100 SessionError error() const;
101 QString errorString() const;
102 QVariant sessionProperty(const QString &key) const;
103 void setSessionProperty(const QString &key, const QVariant &value);
104
105 quint64 bytesWritten() const;
106 quint64 bytesReceived() const;
107 quint64 activeTime() const;
108
109 QNetworkSession::UsagePolicies usagePolicies() const;
110
111 bool waitForOpened(int msecs = 30000);
112
113public Q_SLOTS:
114 void open();
115 void close();
116 void stop();
117
118 //roaming related slots
119 void migrate();
120 void ignore();
121 void accept();
122 void reject();
123
124Q_SIGNALS:
125 void stateChanged(QNetworkSession::State);
126 void opened();
127 void closed();
128 void error(QNetworkSession::SessionError);
129 void preferredConfigurationChanged(const QNetworkConfiguration &config, bool isSeamless);
130 void newConfigurationActivated();
131 void usagePoliciesChanged(QNetworkSession::UsagePolicies usagePolicies);
132
133protected:
134 virtual void connectNotify(const QMetaMethod &signal) override;
135 virtual void disconnectNotify(const QMetaMethod &signal) override;
136
137private:
138 Q_DISABLE_COPY(QNetworkSession)
139 friend class QNetworkSessionPrivate;
140 QNetworkSessionPrivate *d;
141};
142
143QT_END_NAMESPACE
144Q_DECLARE_METATYPE(QNetworkSession::State)
145Q_DECLARE_METATYPE(QNetworkSession::SessionError)
146Q_DECLARE_METATYPE(QNetworkSession::UsagePolicies)
147
148#endif // QT_NO_BEARERMANAGEMENT
149
150#endif // QNETWORKSESSION_H
151