qnetworksession.h 4.5 KB

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