src/websockets/qwebsocketserver.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QWEBSOCKETSERVER_H
  43 #define QWEBSOCKETSERVER_H
  44
  45 #include "QtWebSockets/qwebsockets_global.h"
  46 #include "QtWebSockets/qwebsocketprotocol.h"
  47
  48 #include <QtCore/QObject>
  49 #include <QtCore/QString>
  50 #include <QtNetwork/QHostAddress>
  51
  52 #ifndef QT_NO_SSL
  53 #include <QtNetwork/QSslConfiguration>
  54 #include <QtNetwork/QSslError>
  55 #endif
  56
  57 QT_BEGIN_NAMESPACE
  58
  59 class QWebSocketServerPrivate;
  60 class QWebSocket;
  61 class QWebSocketCorsAuthenticator;
  62
  63 class Q_WEBSOCKETS_EXPORT QWebSocketServer : public QObject
  64 {
  65     Q_OBJECT
  66     Q_DISABLE_COPY(QWebSocketServer)
  67     Q_DECLARE_PRIVATE(QWebSocketServer)
  68
  69     Q_ENUMS(SecureMode)
  70
  71 public:
  72     enum SecureMode {
  73 #ifndef QT_NO_SSL
  74         SECURE_MODE,
  75 #endif
  76         NON_SECURE_MODE
  77     };
  78
  79     explicit QWebSocketServer(const QString &serverName, SecureMode secureMode, QObject *parent = Q_NULLPTR);
  80     virtual ~QWebSocketServer();
  81
  82     bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0);
  83     void close();
  84
  85     bool isListening() const;
  86
  87     void setMaxPendingConnections(int numConnections);
  88     int maxPendingConnections() const;
  89
  90     quint16 serverPort() const;
  91     QHostAddress serverAddress() const;
  92
  93     SecureMode secureMode() const;
  94
  95     bool setSocketDescriptor(int socketDescriptor);
  96     int socketDescriptor() const;
  97
  98     bool hasPendingConnections() const;
  99     virtual QWebSocket *nextPendingConnection();
 100
 101     QWebSocketProtocol::CloseCode error() const;
 102     QString errorString() const;
 103
 104     void pauseAccepting();
 105     void resumeAccepting();
 106
 107     void setServerName(const QString &serverName);
 108     QString serverName() const;
 109
 110 #ifndef QT_NO_NETWORKPROXY
 111     void setProxy(const QNetworkProxy &networkProxy);
 112     QNetworkProxy proxy() const;
 113 #endif
 114 #ifndef QT_NO_SSL
 115     void setSslConfiguration(const QSslConfiguration &sslConfiguration);
 116     QSslConfiguration sslConfiguration() const;
 117 #endif
 118
 119     QList<QWebSocketProtocol::Version> supportedVersions() const;
 120     QStringList supportedProtocols() const;
 121     QStringList supportedExtensions() const;
 122
 123 Q_SIGNALS:
 124     void acceptError(QAbstractSocket::SocketError socketError);
 125     void serverError(QWebSocketProtocol::CloseCode closeCode);
 126     //TODO: should use a delegate iso of a synchronous signal
 127     void originAuthenticationRequired(QWebSocketCorsAuthenticator *pAuthenticator);
 128     void newConnection();
 129 #ifndef QT_NO_SSL
 130     void peerVerifyError(const QSslError &error);
 131     void sslErrors(const QList<QSslError> &errors);
 132 #endif
 133     void closed();
 134
 135 private:
 136     QWebSocketServerPrivate * const d_ptr;
 137 };
 138
 139 QT_END_NAMESPACE
 140
 141 #endif // QWEBSOCKETSERVER_H