src/websockets/qwebsocketserver_p.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_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 "qwebsocket.h"
  60
  61 #ifndef QT_NO_SSL
  62 #include <QtNetwork/QSslConfiguration>
  63 #include <QtNetwork/QSslError>
  64 #endif
  65
  66 QT_BEGIN_NAMESPACE
  67
  68 class QTcpServer;
  69 class QWebSocketServer;
  70
  71 class QWebSocketServerPrivate : public QObject
  72 {
  73     Q_OBJECT
  74     Q_DISABLE_COPY(QWebSocketServerPrivate)
  75     Q_DECLARE_PUBLIC(QWebSocketServer)
  76
  77 public:
  78     enum SecureMode
  79     {
  80         SECURE_MODE = true,
  81         NON_SECURE_MODE
  82     };
  83
  84     explicit QWebSocketServerPrivate(const QString &serverName, SecureMode secureMode, QWebSocketServer * const pWebSocketServer, QObject *parent = Q_NULLPTR);
  85     virtual ~QWebSocketServerPrivate();
  86
  87     void close();
  88     QString errorString() const;
  89     bool hasPendingConnections() const;
  90     bool isListening() const;
  91     bool listen(const QHostAddress &address = QHostAddress::Any, quint16 port = 0);
  92     int maxPendingConnections() const;
  93     virtual QWebSocket *nextPendingConnection();
  94     void pauseAccepting();
  95 #ifndef QT_NO_NETWORKPROXY
  96     QNetworkProxy proxy() const;
  97     void setProxy(const QNetworkProxy &networkProxy);
  98 #endif
  99     void resumeAccepting();
 100     QHostAddress serverAddress() const;
 101     QWebSocketProtocol::CloseCode serverError() const;
 102     quint16 serverPort() const;
 103     void setMaxPendingConnections(int numConnections);
 104     bool setSocketDescriptor(qintptr socketDescriptor);
 105     qintptr socketDescriptor() const;
 106
 107     QList<QWebSocketProtocol::Version> supportedVersions() const;
 108     QStringList supportedProtocols() const;
 109     QStringList supportedExtensions() const;
 110
 111     void setServerName(const QString &serverName);
 112     QString serverName() const;
 113
 114     SecureMode secureMode() const;
 115
 116 #ifndef QT_NO_SSL
 117     void setSslConfiguration(const QSslConfiguration &sslConfiguration);
 118     QSslConfiguration sslConfiguration() const;
 119 #endif
 120
 121     void setError(QWebSocketProtocol::CloseCode code, QString errorString);
 122
 123 private Q_SLOTS:
 124     void onNewConnection();
 125     void onCloseConnection();
 126     void handshakeReceived();
 127
 128 private:
 129     QWebSocketServer * const q_ptr;
 130
 131     QTcpServer *m_pTcpServer;
 132     QString m_serverName;
 133     SecureMode m_secureMode;
 134     QQueue<QWebSocket *> m_pendingConnections;
 135     QWebSocketProtocol::CloseCode m_error;
 136     QString m_errorString;
 137
 138     void addPendingConnection(QWebSocket *pWebSocket);
 139 };
 140
 141 QT_END_NAMESPACE
 142
 143 #endif // QWEBSOCKETSERVER_P_H