src/websockets/qwebsocket_p.h

   1 /*
   2 QWebSockets implements the WebSocket protocol as defined in RFC 6455.
   3 Copyright (C) 2013 Kurt Pattyn (pattyn.kurt@gmail.com)
   4
   5 This library is free software; you can redistribute it and/or
   6 modify it under the terms of the GNU Lesser General Public
   7 License as published by the Free Software Foundation; either
   8 version 2.1 of the License, or (at your option) any later version.
   9
  10 This library is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public
  16 License along with this library; if not, write to the Free Software
  17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  18 */
  19
  20 #ifndef QWEBSOCKET_P_H
  21 #define QWEBSOCKET_P_H
  22 //
  23 //  W A R N I N G
  24 //  -------------
  25 //
  26 // This file is not part of the Qt API.  It exists purely as an
  27 // implementation detail.  This header file may change from version to
  28 // version without notice, or even be removed.
  29 //
  30 // We mean it.
  31 //
  32
  33 #include <QUrl>
  34 #include <QHostAddress>
  35 #ifndef QT_NO_NETWORKPROXY
  36 #include <QNetworkProxy>
  37 #endif
  38 #include <QTime>
  39
  40 #include "qwebsocketprotocol.h"
  41 #include "qwebsocketdataprocessor_p.h"
  42
  43 QT_BEGIN_NAMESPACE
  44
  45 class QWebSocketHandshakeRequest;
  46 class QWebSocketHandshakeResponse;
  47 class QTcpSocket;
  48 class QWebSocket;
  49
  50 class QWebSocketPrivate : public QObject
  51 {
  52     Q_OBJECT
  53     Q_DISABLE_COPY(QWebSocketPrivate)
  54     Q_DECLARE_PUBLIC(QWebSocket)
  55
  56 public:
  57     explicit QWebSocketPrivate(const QString &origin,
  58                                QWebSocketProtocol::Version version,
  59                                QWebSocket * const pWebSocket,
  60                                QObject *parent = 0);
  61     virtual ~QWebSocketPrivate();
  62
  63     void abort();
  64     QAbstractSocket::SocketError error() const;
  65     QString errorString() const;
  66     bool flush();
  67     bool isValid() const;
  68     QHostAddress localAddress() const;
  69     quint16 localPort() const;
  70     QAbstractSocket::PauseModes pauseMode() const;
  71     QHostAddress peerAddress() const;
  72     QString peerName() const;
  73     quint16 peerPort() const;
  74 #ifndef QT_NO_NETWORKPROXY
  75     QNetworkProxy proxy() const;
  76     void setProxy(const QNetworkProxy &networkProxy);
  77 #endif
  78     qint64 readBufferSize() const;
  79     void resume();
  80     void setPauseMode(QAbstractSocket::PauseModes pauseMode);
  81     void setReadBufferSize(qint64 size);
  82     void setSocketOption(QAbstractSocket::SocketOption option, const QVariant &value);
  83     QVariant socketOption(QAbstractSocket::SocketOption option);
  84     QAbstractSocket::SocketState state() const;
  85
  86     bool waitForConnected(int msecs);
  87     bool waitForDisconnected(int msecs);
  88
  89     QWebSocketProtocol::Version version() const;
  90     QString resourceName() const;
  91     QUrl requestUrl() const;
  92     QString origin() const;
  93     QString protocol() const;
  94     QString extension() const;
  95
  96     qint64 write(const char *message);          //send data as text
  97     qint64 write(const char *message, qint64 maxSize);          //send data as text
  98     qint64 write(const QString &message);       //send data as text
  99     qint64 write(const QByteArray &data);       //send data as binary
 100
 101 public Q_SLOTS:
 102     void close(QWebSocketProtocol::CloseCode closeCode, QString reason);
 103     void open(const QUrl &url, bool mask);
 104     void ping(const QByteArray &payload);
 105
 106 private Q_SLOTS:
 107     void processData();
 108     void processPing(QByteArray data);
 109     void processPong(QByteArray data);
 110     void processClose(QWebSocketProtocol::CloseCode closeCode, QString closeReason);
 111     void processHandshake(QTcpSocket *pSocket);
 112     void processStateChanged(QAbstractSocket::SocketState socketState);
 113
 114 private:
 115     QWebSocket * const q_ptr;
 116
 117     QWebSocketPrivate(QTcpSocket *pTcpSocket, QWebSocketProtocol::Version version, QWebSocket *pWebSocket, QObject *parent = 0);
 118     void setVersion(QWebSocketProtocol::Version version);
 119     void setResourceName(const QString &resourceName);
 120     void setRequestUrl(const QUrl &requestUrl);
 121     void setOrigin(const QString &origin);
 122     void setProtocol(const QString &protocol);
 123     void setExtension(const QString &extension);
 124     void enableMasking(bool enable);
 125     void setSocketState(QAbstractSocket::SocketState state);
 126     void setErrorString(const QString &errorString);
 127
 128     qint64 doWriteData(const QByteArray &data, bool isBinary);
 129     qint64 doWriteFrames(const QByteArray &data, bool isBinary);
 130
 131     void makeConnections(const QTcpSocket *pTcpSocket);
 132     void releaseConnections(const QTcpSocket *pTcpSocket);
 133
 134     QByteArray getFrameHeader(QWebSocketProtocol::OpCode opCode, quint64 payloadLength, quint32 maskingKey, bool lastFrame) const;
 135     QString calculateAcceptKey(const QString &key) const;
 136     QString createHandShakeRequest(QString resourceName,
 137                                    QString host,
 138                                    QString origin,
 139                                    QString extensions,
 140                                    QString protocols,
 141                                    QByteArray key);
 142
 143     static QWebSocket *upgradeFrom(QTcpSocket *tcpSocket,
 144                                    const QWebSocketHandshakeRequest &request,
 145                                    const QWebSocketHandshakeResponse &response,
 146                                    QObject *parent = 0);
 147
 148     quint32 generateMaskingKey() const;
 149     QByteArray generateKey() const;
 150     quint32 generateRandomNumber() const;
 151     qint64 writeFrames(const QList<QByteArray> &frames);
 152     qint64 writeFrame(const QByteArray &frame);
 153
 154     QTcpSocket *m_pSocket;
 155     QString m_errorString;
 156     QWebSocketProtocol::Version m_version;
 157     QUrl m_resource;
 158     QString m_resourceName;
 159     QUrl m_requestUrl;
 160     QString m_origin;
 161     QString m_protocol;
 162     QString m_extension;
 163     QAbstractSocket::SocketState m_socketState;
 164
 165     QByteArray m_key;   //identification key used in handshake requests
 166
 167     bool m_mustMask;    //a server must not mask the frames it sends
 168
 169     bool m_isClosingHandshakeSent;
 170     bool m_isClosingHandshakeReceived;
 171
 172     QTime m_pingTimer;
 173
 174     QWebSocketDataProcessor m_dataProcessor;
 175
 176     friend class QWebSocketServerPrivate;
 177 };
 178
 179 QT_END_NAMESPACE
 180
 181 #endif // QWEBSOCKET_H