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