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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/*
* ngtcp2
*
* Copyright (c) 2017 ngtcp2 contributors
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef NGTCP2_CONV_H
#define NGTCP2_CONV_H
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* HAVE_CONFIG_H */
#include <ngtcp2/ngtcp2.h>
/*
* ngtcp2_get_uint64 reads 8 bytes from |p| as 64 bits unsigned
* integer encoded as network byte order, and stores it in the buffer
* pointed by |dest| in host byte order. It returns |p| + 8.
*/
const uint8_t *ngtcp2_get_uint64(uint64_t *dest, const uint8_t *p);
/*
* ngtcp2_get_uint48 reads 6 bytes from |p| as 48 bits unsigned
* integer encoded as network byte order, and stores it in the buffer
* pointed by |dest| in host byte order. It returns |p| + 6.
*/
const uint8_t *ngtcp2_get_uint48(uint64_t *dest, const uint8_t *p);
/*
* ngtcp2_get_uint32 reads 4 bytes from |p| as 32 bits unsigned
* integer encoded as network byte order, and stores it in the buffer
* pointed by |dest| in host byte order. It returns |p| + 4.
*/
const uint8_t *ngtcp2_get_uint32(uint32_t *dest, const uint8_t *p);
/*
* ngtcp2_get_uint24 reads 3 bytes from |p| as 24 bits unsigned
* integer encoded as network byte order, and stores it in the buffer
* pointed by |dest| in host byte order. It returns |p| + 3.
*/
const uint8_t *ngtcp2_get_uint24(uint32_t *dest, const uint8_t *p);
/*
* ngtcp2_get_uint16 reads 2 bytes from |p| as 16 bits unsigned
* integer encoded as network byte order, and stores it in the buffer
* pointed by |dest| in host byte order. It returns |p| + 2.
*/
const uint8_t *ngtcp2_get_uint16(uint16_t *dest, const uint8_t *p);
/*
* ngtcp2_get_uint16be reads 2 bytes from |p| as 16 bits unsigned
* integer encoded as network byte order, and stores it in the buffer
* pointed by |dest| as is. It returns |p| + 2.
*/
const uint8_t *ngtcp2_get_uint16be(uint16_t *dest, const uint8_t *p);
/*
* ngtcp2_get_uvarint reads variable-length unsigned integer from |p|,
* and stores it in the buffer pointed by |dest| in host byte order.
* It returns |p| plus the number of bytes read from |p|.
*/
const uint8_t *ngtcp2_get_uvarint(uint64_t *dest, const uint8_t *p);
/*
* ngtcp2_get_varint reads variable-length unsigned integer from |p|,
* and casts it to the signed integer, and stores it in the buffer
* pointed by |dest| in host byte order. No information should be
* lost in this cast, because the variable-length integer is 62
* bits. It returns |p| plus the number of bytes read from |p|.
*/
const uint8_t *ngtcp2_get_varint(int64_t *dest, const uint8_t *p);
/*
* ngtcp2_get_pkt_num reads encoded packet number from |p|. The
* packet number is encoed in |pkt_numlen| bytes.
*/
int64_t ngtcp2_get_pkt_num(const uint8_t *p, size_t pkt_numlen);
/*
* ngtcp2_put_uint64be writes |n| in host byte order in |p| in network
* byte order. It returns the one beyond of the last written
* position.
*/
uint8_t *ngtcp2_put_uint64be(uint8_t *p, uint64_t n);
/*
* ngtcp2_put_uint48be writes |n| in host byte order in |p| in network
* byte order. It writes only least significant 48 bits. It returns
* the one beyond of the last written position.
*/
uint8_t *ngtcp2_put_uint48be(uint8_t *p, uint64_t n);
/*
* ngtcp2_put_uint32be writes |n| in host byte order in |p| in network
* byte order. It returns the one beyond of the last written
* position.
*/
uint8_t *ngtcp2_put_uint32be(uint8_t *p, uint32_t n);
/*
* ngtcp2_put_uint24be writes |n| in host byte order in |p| in network
* byte order. It writes only least significant 24 bits. It returns
* the one beyond of the last written position.
*/
uint8_t *ngtcp2_put_uint24be(uint8_t *p, uint32_t n);
/*
* ngtcp2_put_uint16be writes |n| in host byte order in |p| in network
* byte order. It returns the one beyond of the last written
* position.
*/
uint8_t *ngtcp2_put_uint16be(uint8_t *p, uint16_t n);
/*
* ngtcp2_put_uint16 writes |n| as is in |p|. It returns the one
* beyond of the last written position.
*/
uint8_t *ngtcp2_put_uint16(uint8_t *p, uint16_t n);
/*
* ngtcp2_put_uvarint writes |n| in |p| using variable-length integer
* encoding. It returns the one beyond of the last written position.
*/
uint8_t *ngtcp2_put_uvarint(uint8_t *p, uint64_t n);
/*
* ngtcp2_put_uvarint30 writes |n| in |p| using variable-length
* integer encoding. |n| must be strictly less than 1073741824. The
* function always encodes |n| in 4 bytes. It returns the one beyond
* of the last written position.
*/
uint8_t *ngtcp2_put_uvarint30(uint8_t *p, uint32_t n);
/*
* ngtcp2_put_pkt_num encodes |pkt_num| using |len| bytes. It
* returns the one beyond of the last written position.
*/
uint8_t *ngtcp2_put_pkt_num(uint8_t *p, int64_t pkt_num, size_t len);
/*
* ngtcp2_get_uvarintlen returns the required number of bytes to read
* variable-length integer starting at |p|.
*/
size_t ngtcp2_get_uvarintlen(const uint8_t *p);
/*
* ngtcp2_put_uvarintlen returns the required number of bytes to
* encode |n|.
*/
size_t ngtcp2_put_uvarintlen(uint64_t n);
/*
* ngtcp2_nth_server_bidi_id returns |n|-th server bidirectional
* stream ID. If |n| is 0, it returns 0. If the |n|-th stream ID is
* larger than NGTCP2_MAX_SERVER_STREAM_ID_BIDI, this function returns
* NGTCP2_MAX_SERVER_STREAM_ID_BIDI.
*/
int64_t ngtcp2_nth_server_bidi_id(uint64_t n);
/*
* ngtcp2_nth_client_bidi_id returns |n|-th client bidirectional
* stream ID. If |n| is 0, it returns 0. If the |n|-th stream ID is
* larger than NGTCP2_MAX_CLIENT_STREAM_ID_BIDI, this function returns
* NGTCP2_MAX_CLIENT_STREAM_ID_BIDI.
*/
int64_t ngtcp2_nth_client_bidi_id(uint64_t n);
/*
* ngtcp2_nth_server_uni_id returns |n|-th server unidirectional
* stream ID. If |n| is 0, it returns 0. If the |n|-th stream ID is
* larger than NGTCP2_MAX_SERVER_STREAM_ID_UNI, this function returns
* NGTCP2_MAX_SERVER_STREAM_ID_UNI.
*/
int64_t ngtcp2_nth_server_uni_id(uint64_t n);
/*
* ngtcp2_nth_client_uni_id returns |n|-th client unidirectional
* stream ID. If |n| is 0, it returns 0. If the |n|-th stream ID is
* larger than NGTCP2_MAX_CLIENT_STREAM_ID_UNI, this function returns
* NGTCP2_MAX_CLIENT_STREAM_ID_UNI.
*/
int64_t ngtcp2_nth_client_uni_id(uint64_t n);
/*
* ngtcp2_ord_stream_id returns the ordinal number of |stream_id|.
*/
uint64_t ngtcp2_ord_stream_id(int64_t stream_id);
#endif /* NGTCP2_CONV_H */
|
