Skip to content
GitLab
Select Git revision
  • 6.2.2
  • dev default
  • 6.2
  • 6.2.1
  • 6.2.0
  • 5.12
  • 5.12.12
  • 5.15
  • 5.12.11
  • 5.15.2
  • 5.12.10
  • 5.15.1
  • 5.12.9
  • 5.15.0
  • 5.14
  • wip/cmake
  • 5.12.8
  • 5.14.2
  • 5.14.1
  • 5.12.7
  • v5.15.0-alpha1
  • v5.12.7
  • v5.14.1
  • v5.9.9
  • v5.14.0
  • v5.14.0-rc2
  • v5.14.0-rc1
  • v5.12.6
  • v5.14.0-beta3
  • v5.13.2
  • v5.14.0-beta2
  • v5.14.0-beta1
  • v5.14.0-alpha1
  • v5.12.5
  • v5.13.1
  • v5.13.0
  • v5.13.0-rc3
  • v5.12.4
  • v5.13.0-rc2
  • v5.13.0-rc1
Find file BlameHistoryPermalink
qwebsocketserver.h 4.44 KiB
1 
/****************************************************************************
2 
**
3 
** Copyright (C) 2016 Kurt Pattyn <pattyn.kurt@gmail.com>.
4 
** Contact: https://www.qt.io/licensing/
5 
**
6 
** This file is part of the QtWebSockets 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 QWEBSOCKETSERVER_H
41 
#define QWEBSOCKETSERVER_H
42
43 
#include "QtWebSockets/qwebsockets_global.h"
44 
#include "QtWebSockets/qwebsocketprotocol.h"
45
46 
#include <QtCore/QObject>
47 
#include <QtCore/QString>
48 
#include <QtNetwork/QHostAddress>
49
50 
#ifndef QT_NO_SSL
51 
#include <QtNetwork/QSslConfiguration>
52 
#include <QtNetwork/QSslError>
53 
#endif
54
55 
QT_BEGIN_NAMESPACE
56
57 
class QWebSocketServerPrivate;
58 
class QWebSocket;
59 
class QWebSocketCorsAuthenticator;
60
61 
class Q_WEBSOCKETS_EXPORT QWebSocketServer : public QObject
62 
{
63 
    Q_OBJECT
64 
    Q_DISABLE_COPY(QWebSocketServer)
65 
    Q_DECLARE_PRIVATE(QWebSocketServer)
66
67 
    Q_ENUMS(SslMode)
68
69 
public:
70 
    enum SslMode {
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
#ifndef QT_NO_SSL SecureMode, #endif NonSecureMode }; explicit QWebSocketServer(const QString &serverName, SslMode secureMode, QObject *parent = Q_NULLPTR); virtual ~QWebSocketServer(); bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0); void close(); bool isListening() const; void setMaxPendingConnections(int numConnections); int maxPendingConnections() const; quint16 serverPort() const; QHostAddress serverAddress() const; QUrl serverUrl() const; SslMode secureMode() const; bool setSocketDescriptor(int socketDescriptor); int socketDescriptor() const; bool hasPendingConnections() const; virtual QWebSocket *nextPendingConnection(); QWebSocketProtocol::CloseCode error() const; QString errorString() const; void pauseAccepting(); void resumeAccepting(); void setServerName(const QString &serverName); QString serverName() const; #ifndef QT_NO_NETWORKPROXY void setProxy(const QNetworkProxy &networkProxy); QNetworkProxy proxy() const; #endif #ifndef QT_NO_SSL void setSslConfiguration(const QSslConfiguration &sslConfiguration); QSslConfiguration sslConfiguration() const; #endif QList<QWebSocketProtocol::Version> supportedVersions() const; Q_SIGNALS: void acceptError(QAbstractSocket::SocketError socketError); void serverError(QWebSocketProtocol::CloseCode closeCode); //TODO: should use a delegate iso of a synchronous signal //see also QTBUG-16251 void originAuthenticationRequired(QWebSocketCorsAuthenticator *pAuthenticator); void newConnection(); #ifndef QT_NO_SSL void peerVerifyError(const QSslError &error); void sslErrors(const QList<QSslError> &errors); void preSharedKeyAuthenticationRequired(QSslPreSharedKeyAuthenticator *authenticator); #endif void closed(); }; QT_END_NAMESPACE #endif // QWEBSOCKETSERVER_H