1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtNetwork module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef HTTP2FRAMES_P_H
#define HTTP2FRAMES_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists for the convenience
// of the Network Access API. This header file may change from
// version to version without notice, or even be removed.
//
// We mean it.
//
#include "http2protocol_p.h"
#include "hpack_p.h"
#include <QtCore/qendian.h>
#include <QtCore/qglobal.h>
#include <algorithm>
#include <vector>
QT_BEGIN_NAMESPACE
class QHttp2ProtocolHandler;
class QAbstractSocket;
namespace Http2
{
struct Q_AUTOTEST_EXPORT Frame
{
Frame();
// Reading these values without first forming a valid frame (either reading
// it from a socket or building it) will result in undefined behavior:
FrameType type() const;
quint32 streamID() const;
FrameFlags flags() const;
quint32 payloadSize() const;
uchar padding() const;
// In HTTP/2 a stream's priority is specified by its weight and a stream
// (id) it depends on:
bool priority(quint32 *streamID = nullptr,
uchar *weight = nullptr) const;
FrameStatus validateHeader() const;
FrameStatus validatePayload() const;
// Number of payload bytes without padding and/or priority.
quint32 dataSize() const;
// HEADERS data size for HEADERS, PUSH_PROMISE and CONTINUATION streams:
quint32 hpackBlockSize() const;
// Beginning of payload without priority/padding bytes.
const uchar *dataBegin() const;
// HEADERS data beginning for HEADERS, PUSH_PROMISE and CONTINUATION streams:
const uchar *hpackBlockBegin() const;
std::vector<uchar> buffer;
};
class Q_AUTOTEST_EXPORT FrameReader
{
public:
FrameStatus read(QAbstractSocket &socket);
Frame &inboundFrame()
{
return frame;
}
private:
bool readHeader(QAbstractSocket &socket);
bool readPayload(QAbstractSocket &socket);
quint32 offset = 0;
Frame frame;
};
class Q_AUTOTEST_EXPORT FrameWriter
{
public:
using payload_type = std::vector<uchar>;
using size_type = payload_type::size_type;
FrameWriter();
FrameWriter(FrameType type, FrameFlags flags, quint32 streamID);
Frame &outboundFrame()
{
return frame;
}
// Frame 'builders':
void start(FrameType type, FrameFlags flags, quint32 streamID);
void setPayloadSize(quint32 size);
void setType(FrameType type);
void setFlags(FrameFlags flags);
void addFlag(FrameFlag flag);
// All append functions also update frame's payload length.
template<typename ValueType>
void append(ValueType val)
{
uchar wired[sizeof val] = {};
qToBigEndian(val, wired);
append(wired, wired + sizeof val);
}
void append(uchar val)
{
frame.buffer.push_back(val);
updatePayloadSize();
}
void append(Settings identifier)
{
append(quint16(identifier));
}
void append(const payload_type &payload)
{
append(&payload[0], &payload[0] + payload.size());
}
void append(const uchar *begin, const uchar *end);
// Write as a single frame:
bool write(QAbstractSocket &socket) const;
// Two types of frames we are sending are affected by frame size limits:
// HEADERS and DATA. HEADERS' payload (hpacked HTTP headers, following a
// frame header) is always in our 'buffer', we send the initial HEADERS
// frame first and then CONTINUTATION frame(s) if needed:
bool writeHEADERS(QAbstractSocket &socket, quint32 sizeLimit);
// With DATA frames the actual payload is never in our 'buffer', it's a
// 'readPointer' from QNonContiguousData. We split this payload as needed
// into DATA frames with correct payload size fitting into frame size limit:
bool writeDATA(QAbstractSocket &socket, quint32 sizeLimit,
const uchar *src, quint32 size);
private:
void updatePayloadSize();
Frame frame;
};
}
QT_END_NAMESPACE
#endif
|
