src/websockets/qwebsocketserver_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
   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_P_H
  43 #define QWEBSOCKETSERVER_P_H
  44 //
  45 //  W A R N I N G
  46 //  -------------
  47 //
  48 // This file is not part of the Qt API.  It exists purely as an
  49 // implementation detail.  This header file may change from version to
  50 // version without notice, or even be removed.
  51 //
  52 // We mean it.
  53 //
  54
  55 #include <QtCore/QObject>
  56 #include <QtCore/QQueue>
  57 #include <QtCore/QString>
  58 #include <QtNetwork/QHostAddress>
  59 #include <private/qobject_p.h>
  60 #include "qwebsocket.h"
  61
  62 #ifndef QT_NO_SSL
  63 #include <QtNetwork/QSslConfiguration>
  64 #include <QtNetwork/QSslError>
  65 #endif
  66
  67 QT_BEGIN_NAMESPACE
  68
  69 class QTcpServer;
  70 class QWebSocketServer;
  71
  72 class QWebSocketServerPrivate : public QObjectPrivate
  73 {
  74     Q_DISABLE_COPY(QWebSocketServerPrivate)
  75
  76 public:
  77     Q_DECLARE_PUBLIC(QWebSocketServer)
  78     enum SslMode
  79     {
  80         SecureMode = true,
  81         NonSecureMode
  82     };
  83
  84     explicit QWebSocketServerPrivate(const QString &serverName, SslMode secureMode,
  85                                      QWebSocketServer * const pWebSocketServer);
  86     virtual ~QWebSocketServerPrivate();
  87
  88     void init();
  89     void close(bool aboutToDestroy = false);
  90     QString errorString() const;
  91     bool hasPendingConnections() const;
  92     bool isListening() const;
  93     bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0);
  94     int maxPendingConnections() const;
  95     virtual QWebSocket *nextPendingConnection();
  96     void pauseAccepting();
  97 #ifndef QT_NO_NETWORKPROXY
  98     QNetworkProxy proxy() const;
  99     void setProxy(const QNetworkProxy &networkProxy);
 100 #endif
 101     void resumeAccepting();
 102     QHostAddress serverAddress() const;
 103     QWebSocketProtocol::CloseCode serverError() const;
 104     quint16 serverPort() const;
 105     void setMaxPendingConnections(int numConnections);
 106     bool setSocketDescriptor(qintptr socketDescriptor);
 107     qintptr socketDescriptor() const;
 108
 109     QList<QWebSocketProtocol::Version> supportedVersions() const;
 110     QStringList supportedProtocols() const;
 111     QStringList supportedExtensions() const;
 112
 113     void setServerName(const QString &serverName);
 114     QString serverName() const;
 115
 116     SslMode secureMode() const;
 117
 118 #ifndef QT_NO_SSL
 119     void setSslConfiguration(const QSslConfiguration &sslConfiguration);
 120     QSslConfiguration sslConfiguration() const;
 121 #endif
 122
 123     void setError(QWebSocketProtocol::CloseCode code, const QString &errorString);
 124
 125     QWebSocketServer * const q_ptr;
 126
 127 private:
 128     QTcpServer *m_pTcpServer;
 129     QString m_serverName;
 130     SslMode m_secureMode;
 131     QQueue<QWebSocket *> m_pendingConnections;
 132     QWebSocketProtocol::CloseCode m_error;
 133     QString m_errorString;
 134
 135     void addPendingConnection(QWebSocket *pWebSocket);
 136     void setErrorFromSocketError(QAbstractSocket::SocketError error,
 137                                  const QString &errorDescription);
 138
 139     void onNewConnection();
 140     void onCloseConnection();
 141     void handshakeReceived();
 142 };
 143
 144 QT_END_NAMESPACE
 145
 146 #endif // QWEBSOCKETSERVER_P_H