1 /****************************************************************************
3 ** Copyright (C) 2014 Kurt Pattyn <pattyn.kurt@gmail.com>.
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtWebSockets module of the Qt Toolkit.
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.
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.
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.
32 ****************************************************************************/
34 #ifndef QWEBSOCKETFRAME_P_H
35 #define QWEBSOCKETFRAME_P_H
37 #include <QtCore/QString>
38 #include <QtCore/QByteArray>
41 #include "qwebsockets_global.h"
42 #include "qwebsocketprotocol.h"
43 #include "qwebsocketprotocol_p.h"
49 const quint64 MAX_FRAME_SIZE_IN_BYTES = INT_MAX - 1;
50 const quint64 MAX_MESSAGE_SIZE_IN_BYTES = INT_MAX - 1;
52 class Q_AUTOTEST_EXPORT QWebSocketFrame
56 QWebSocketFrame(const QWebSocketFrame &other);
58 QWebSocketFrame &operator =(const QWebSocketFrame &other);
60 #ifdef Q_COMPILER_RVALUE_REFS
61 QWebSocketFrame(QWebSocketFrame &&other);
62 QWebSocketFrame &operator =(QWebSocketFrame &&other);
65 void swap(QWebSocketFrame &other);
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;
74 quint32 mask() const; //returns 0 if no mask
78 QWebSocketProtocol::OpCode opCode() const;
79 QByteArray payload() const;
85 static QWebSocketFrame readFrame(QIODevice *pIoDevice);
88 QWebSocketProtocol::CloseCode m_closeCode;
89 QString m_closeReason;
95 QWebSocketProtocol::OpCode m_opCode;
105 PS_READ_PAYLOAD_LENGTH,
106 PS_READ_BIG_PAYLOAD_LENGTH,
110 PS_WAIT_FOR_MORE_DATA
113 void setError(QWebSocketProtocol::CloseCode code, const QString &closeReason);
114 bool checkValidity();
119 #endif // QWEBSOCKETFRAME_P_H