summaryrefslogtreecommitdiffhomepage
path: root/src/chunklets/msg.h
blob: c40bdbe5fb2345537c2b95358fe32a90193dc5aa (plain)
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
 * Copyright © 2023 Michael Smith <mikesmiffy128@gmail.com>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef INC_CHUNKLETS_MSG_H
#define INC_CHUNKLETS_MSG_H

#ifdef __cplusplus
#define _msg_Bool bool
extern "C" {
#else
#define _msg_Bool _Bool
#endif

/*
 * Writes a nil (null) message to the buffer out. Always writes a single byte.
 *
 * out must point to at least 1 byte.
 */
void msg_putnil(unsigned char *out);

/*
 * Writes the boolean val to the buffer out. Always writes a single byte.
 *
 * out must point to at least 1 byte.
 */
void msg_putbool(unsigned char *out, _msg_Bool val);

/*
 * Writes the integer val in the range [-32, 127] to the buffer out. Values
 * outside this range will produce an undefined encoding. Always writes a single
 * byte.
 *
 * out must point to at least 1 byte.
 *
 * It is recommended to use msg_puts() for arbitrary signed values or msg_putu()
 * for arbitrary unsigned values. Those functions will produce the smallest
 * possible encoding for any value.
 */
void msg_puti7(unsigned char *out, signed char val);

/*
 * Writes the signed int val in the range [-128, 127] to the buffer out.
 *
 * out must point to at least 2 bytes.
 *
 * Returns the number of bytes written, one of {1, 2}.
 *
 * It is recommended to use msg_puts() for arbitrary signed values. That
 * function will produce the smallest possible encoding for any value.
 */
int msg_puts8(unsigned char *out, signed char val);

/*
 * Writes the unsigned int val in the range [0, 255] to the buffer out.
 *
 * out must point to at least 2 bytes.
 *
 * Returns the number of bytes written, one of {1, 2}.
 *
 * It is recommended to use msg_putu() for arbitrary unsigned values. That
 * function will produce the smallest possible encoding for any value.
 */
int msg_putu8(unsigned char *out, unsigned char val);

/*
 * Writes the signed int val in the range [-65536, 65535] to the buffer out.
 *
 * out must point to at least 3 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3}.
 *
 * It is recommended to use msg_puts() for arbitrary signed values. That
 * function will produce the smallest possible encoding for any value.
 */
int msg_puts16(unsigned char *out, short val);

/*
 * Writes the unsigned int val in the range [0, 65536] to the buffer out.
 *
 * out must point to at least 3 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3}.
 *
 * It is recommended to use msg_putu() for arbitrary unsigned values. That
 * function will produce the smallest possible encoding for any value.
 */
int msg_putu16(unsigned char *out, unsigned short val);

/*
 * Writes the signed int val in the range [-2147483648, 2147483647] to the
 * buffer out.
 *
 * out must point to at least 5 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3, 5}.
 *
 * It is recommended to use msg_puts() for arbitrary signed values. That
 * function will produce the smallest possible encoding for any value.
 */
int msg_puts32(unsigned char *out, int val);

/*
 * Writes the unsigned int val in the range [0, 4294967295] to the buffer out.
 *
 * out must point to at least 5 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3, 5}.
 *
 * It is recommended to use msg_putu() for arbitrary unsigned values. That
 * function will produce the smallest possible encoding for any value.
 */
int msg_putu32(unsigned char *out, unsigned int val);

/*
 * Writes the signed int val in the range [-9223372036854775808,
 * 9223372036854775807] to the buffer out.
 *
 * out must point to at least 9 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3, 5, 9}.
 */
int msg_puts(unsigned char *out, long long val);

/*
 * Writes the unsigned int val in the range [0, 18446744073709551616] to the
 * buffer out.
 *
 * out must point to at least 9 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3, 5, 9}.
 */
int msg_putu(unsigned char *out, unsigned long long val);

/*
 * Writes the IEEE 754 single-precision float val to the buffer out. Always
 * writes 5 bytes.
 *
 * out must point to at least 5 bytes.
 */
void msg_putf(unsigned char *out, float val);

/*
 * Writes the IEEE 754 double-precision float val to the buffer out.
 *
 * out must point to at least 9 bytes.
 *
 * Returns the number of bytes written, one of {5, 9}.
 */
int msg_putd(unsigned char *out, double val);

/*
 * Writes the string size sz in the range [0, 31] to the buffer out. Values
 * outside this range will produce an undefined encoding. Always writes a single
 * byte.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * bytes of the actual string, which must be valid UTF-8.
 *
 * out must point to at least 1 byte.
 *
 * It is recommended to use msg_putssz() for arbitrary string sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
void msg_putssz5(unsigned char *out, int sz);

/*
 * Writes the string size sz in the range [0, 255] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * bytes of the actual string, which must be valid UTF-8.
 *
 * out must point to at least 2 bytes.
 *
 * It is recommended to use msg_putssz() for arbitrary string sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
int msg_putssz8(unsigned char *out, int sz);

/*
 * Writes the string size sz in the range [0, 65535] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * bytes of the actual string, which must be valid UTF-8.
 *
 * out must point to at least 3 bytes.
 *
 * It is recommended to use msg_putssz() for arbitrary string sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
int msg_putssz16(unsigned char *out, int sz);

/*
 * Writes the string size sz in the range [0, 4294967295] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * bytes of the actual string, which must be valid UTF-8.
 *
 * out must point to at least 5 bytes.
 */
int msg_putssz(unsigned char *out, unsigned int sz);

/*
 * Writes the binary blob size sz in the range [0, 255] to the buffer out.
 * Always writes 2 bytes.
 *
 * In a complete message stream, a size of N must be immediately followed by
 * N bytes of the actual data.
 *
 * out must point to at least 2 bytes.
 *
 * It is recommended to use msg_putbsz() for arbitrary binary blob sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
void msg_putbsz8(unsigned char *out, int sz);

/*
 * Writes the binary blob size sz in the range [0, 65535] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by
 * N bytes of the actual data.
 *
 * out must point to at least 3 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3}.
 *
 * It is recommended to use msg_putbsz() for arbitrary binary blob sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
int msg_putbsz16(unsigned char *out, int sz);

/*
 * Writes the binary blob size sz in the range [0, 4294967295] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by
 * N bytes of the actual data.
 *
 * out must point to at least 5 bytes.
 *
 * Returns the number of bytes written, one of {1, 2, 3, 5}.
 */
int msg_putbsz(unsigned char *out, unsigned int sz);

/*
 * Writes the array size sz in the range [0, 15] to the buffer out. Values
 * outside this range will produce an undefined encoding. Always writes a single
 * byte.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * other messages, which form the contents of the array.
 *
 * out must point to at least 1 byte.
 *
 * It is recommended to use msg_putasz() for arbitrary array sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
void msg_putasz4(unsigned char *out, int sz);

/*
 * Writes the array size sz in the range [0, 65535] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * other messages, which form the contents of the array.
 *
 * out must point to at least 3 bytes.
 *
 * Returns the number of bytes written, one of {1, 3}.
 *
 * It is recommended to use msg_putasz() for arbitrary array sizes. That
 * function will produce the smallest possible encoding for any size value.
 */
int msg_putasz16(unsigned char *out, int sz);

/*
 * Writes the array size sz in the range [0, 4294967295] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by N
 * other messages, which form the contents of the array.
 *
 * out must point to at least 5 bytes.
 *
 * Returns the number of bytes written, one of {1, 3, 5}.
 */
int msg_putasz(unsigned char *out, unsigned int sz);

/*
 * Writes the map size sz in the range [0, 15] to the buffer out. Values
 * outside this range will produce an undefined encoding. Always writes a single
 * byte.
 *
 * In a complete message stream, a size of N must be immediately followed by
 * N * 2 other messages, which form the contents of the map as keys followed by
 * values in alternation.
 *
 * out must point to at least 1 byte.
 *
 * It is recommended to use msg_putmsz() for arbitrary map sizes. That function
 * will produce the smallest possible encoding for any size value.
 */
void msg_putmsz4(unsigned char *out, int sz);

/*
 * Writes the array size sz in the range [0, 65536] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by
 * N * 2 other messages, which form the contents of the map as keys followed by
 * values in alternation.
 *
 * out must point to at least 3 bytes.
 *
 * Returns the number of bytes written, one of {1, 3}.
 *
 * It is recommended to use msg_putmsz() for arbitrary map sizes. That function
 * will produce the smallest possible encoding for any size value.
 */
int msg_putmsz16(unsigned char *out, int sz);

/*
 * Writes the array size sz in the range [0, 4294967295] to the buffer out.
 *
 * In a complete message stream, a size of N must be immediately followed by
 * N * 2 other messages, which form the contents of the map as keys followed by
 * values in alternation.
 *
 * out must point to at least 5 bytes.
 *
 * Returns the number of bytes written, one of {1, 3, 5}.
 */
int msg_putmsz(unsigned char *out, unsigned int sz);

#ifdef __cplusplus
}
#endif
#undef _msg_Bool

#endif

// vi: sw=4 ts=4 noet tw=80 cc=80