src/websockets/qwebsocketframe_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 QWEBSOCKETFRAME_P_H
  43 #define QWEBSOCKETFRAME_P_H
  44
  45 #include <QtCore/QString>
  46 #include <QtCore/QByteArray>
  47 #include <limits.h>
  48
  49 #include "qwebsocketprotocol.h"
  50 #include "qwebsockets_global.h"
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 class QIODevice;
  55
  56 const quint64 MAX_FRAME_SIZE_IN_BYTES = INT_MAX - 1;
  57 const quint64 MAX_MESSAGE_SIZE_IN_BYTES = INT_MAX - 1;
  58
  59 class Q_AUTOTEST_EXPORT QWebSocketFrame
  60 {
  61 public:
  62     QWebSocketFrame();
  63     QWebSocketFrame(const QWebSocketFrame &other);
  64
  65     QWebSocketFrame &operator =(const QWebSocketFrame &other);
  66
  67     QWebSocketProtocol::CloseCode closeCode() const;
  68     QString closeReason() const;
  69     bool isFinalFrame() const;
  70     bool isControlFrame() const;
  71     bool isDataFrame() const;
  72     bool isContinuationFrame() const;
  73     bool hasMask() const;
  74     quint32 mask() const;    //returns 0 if no mask
  75     int rsv1() const;
  76     int rsv2() const;
  77     int rsv3() const;
  78     QWebSocketProtocol::OpCode opCode() const;
  79     QByteArray payload() const;
  80
  81     void clear();       //resets all member variables, and invalidates the object
  82
  83     bool isValid() const;
  84
  85     static QWebSocketFrame readFrame(QIODevice *pIoDevice);
  86
  87 private:
  88     QWebSocketProtocol::CloseCode m_closeCode;
  89     QString m_closeReason;
  90     bool m_isFinalFrame;
  91     quint32 m_mask;
  92     int m_rsv1; //reserved field 1
  93     int m_rsv2; //reserved field 2
  94     int m_rsv3; //reserved field 3
  95     QWebSocketProtocol::OpCode m_opCode;
  96
  97     quint8 m_length;        //length field as read from the header; this is 1 byte, which when 126 or 127, indicates a large payload
  98     QByteArray m_payload;
  99
 100     bool m_isValid;
 101
 102     enum ProcessingState
 103     {
 104         PS_READ_HEADER,
 105         PS_READ_PAYLOAD_LENGTH,
 106         PS_READ_BIG_PAYLOAD_LENGTH,
 107         PS_READ_MASK,
 108         PS_READ_PAYLOAD,
 109         PS_DISPATCH_RESULT,
 110         PS_WAIT_FOR_MORE_DATA
 111     };
 112
 113     void setError(QWebSocketProtocol::CloseCode code, QString closeReason);
 114     bool checkValidity();
 115 };
 116
 117 QT_END_NAMESPACE
 118
 119 #endif // QWEBSOCKETFRAME_P_H