Qpid Proton C 0.40.0
 
Loading...
Searching...
No Matches
codec.h
1#ifndef PROTON_CODEC_H
2#define PROTON_CODEC_H 1
3
4/*
5 *
6 * Licensed to the Apache Software Foundation (ASF) under one
7 * or more contributor license agreements. See the NOTICE file
8 * distributed with this work for additional information
9 * regarding copyright ownership. The ASF licenses this file
10 * to you under the Apache License, Version 2.0 (the
11 * "License"); you may not use this file except in compliance
12 * with the License. You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing,
17 * software distributed under the License is distributed on an
18 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19 * KIND, either express or implied. See the License for the
20 * specific language governing permissions and limitations
21 * under the License.
22 *
23 */
24
25#include <proton/import_export.h>
26#include <proton/types.h>
27#include <proton/error.h>
28#include <proton/type_compat.h>
29#include <stdarg.h>
30
31#ifdef __cplusplus
32extern "C" {
33#endif
34
40
46typedef enum {
50 PN_NULL = 1,
51
55 PN_BOOL = 2,
56
60 PN_UBYTE = 3,
61
65 PN_BYTE = 4,
66
70 PN_USHORT = 5,
71
75 PN_SHORT = 6,
76
80 PN_UINT = 7,
81
85 PN_INT = 8,
86
90 PN_CHAR = 9,
91
95 PN_ULONG = 10,
96
100 PN_LONG = 11,
101
106 PN_TIMESTAMP = 12,
107
111 PN_FLOAT = 13,
112
116 PN_DOUBLE = 14,
117
121 PN_DECIMAL32 = 15,
122
126 PN_DECIMAL64 = 16,
127
131 PN_DECIMAL128 = 17,
132
136 PN_UUID = 18,
137
141 PN_BINARY = 19,
142
147 PN_STRING = 20,
148
153 PN_SYMBOL = 21,
154
158 PN_DESCRIBED = 22,
159
163 PN_ARRAY = 23,
164
168 PN_LIST = 24,
169
174 PN_MAP = 25,
175
180 PN_INVALID = -1
181} pn_type_t;
182
190PN_EXTERN const char *pn_type_name(pn_type_t type);
191
199typedef struct {
204 pn_type_t type;
205 union {
209 bool as_bool;
210
214 uint8_t as_ubyte;
215
219 int8_t as_byte;
220
224 uint16_t as_ushort;
225
229 int16_t as_short;
230
234 uint32_t as_uint;
235
239 int32_t as_int;
240
244 pn_char_t as_char;
245
249 uint64_t as_ulong;
250
254 int64_t as_long;
255
259 pn_timestamp_t as_timestamp;
260
264 float as_float;
265
269 double as_double;
270
274 pn_decimal32_t as_decimal32;
275
279 pn_decimal64_t as_decimal64;
280
284 pn_decimal128_t as_decimal128;
285
289 pn_uuid_t as_uuid;
290
298 pn_bytes_t as_bytes;
299 } u;
300} pn_atom_t;
301
311typedef pn_atom_t pn_msgid_t;
312
317
374typedef struct pn_data_t pn_data_t;
375
384PN_EXTERN pn_data_t *pn_data(size_t capacity);
385
391PN_EXTERN void pn_data_free(pn_data_t *data);
392
399PN_EXTERN int pn_data_errno(pn_data_t *data);
400
412PN_EXTERN pn_error_t *pn_data_error(pn_data_t *data);
413
417PN_EXTERN int pn_data_vfill(pn_data_t *data, const char *fmt, va_list ap);
418PN_EXTERN int pn_data_fill(pn_data_t *data, const char *fmt, ...);
419PN_EXTERN int pn_data_vscan(pn_data_t *data, const char *fmt, va_list ap);
420PN_EXTERN int pn_data_scan(pn_data_t *data, const char *fmt, ...);
424
433PN_EXTERN void pn_data_clear(pn_data_t *data);
434
444PN_EXTERN size_t pn_data_size(pn_data_t *data);
445
451PN_EXTERN void pn_data_rewind(pn_data_t *data);
452
461PN_EXTERN bool pn_data_next(pn_data_t *data);
462
471PN_EXTERN bool pn_data_prev(pn_data_t *data);
472
483PN_EXTERN bool pn_data_enter(pn_data_t *data);
484
494PN_EXTERN bool pn_data_exit(pn_data_t *data);
495
499PN_EXTERN bool pn_data_lookup(pn_data_t *data, const char *name);
503
511PN_EXTERN pn_type_t pn_data_type(pn_data_t *data);
512
520PN_EXTERN int pn_data_print(pn_data_t *data);
521
533PN_EXTERN int pn_data_format(pn_data_t *data, char *bytes, size_t *size);
534
545PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size);
546
554PN_EXTERN ssize_t pn_data_encoded_size(pn_data_t *data);
555
573PN_EXTERN ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size);
574
597PN_EXTERN int pn_data_put_list(pn_data_t *data);
598
617PN_EXTERN int pn_data_put_map(pn_data_t *data);
618
652PN_EXTERN int pn_data_put_array(pn_data_t *data, bool described, pn_type_t type);
653
673PN_EXTERN int pn_data_put_described(pn_data_t *data);
674
681PN_EXTERN int pn_data_put_null(pn_data_t *data);
682
690PN_EXTERN int pn_data_put_bool(pn_data_t *data, bool b);
691
699PN_EXTERN int pn_data_put_ubyte(pn_data_t *data, uint8_t ub);
700
708PN_EXTERN int pn_data_put_byte(pn_data_t *data, int8_t b);
709
717PN_EXTERN int pn_data_put_ushort(pn_data_t *data, uint16_t us);
718
726PN_EXTERN int pn_data_put_short(pn_data_t *data, int16_t s);
727
735PN_EXTERN int pn_data_put_uint(pn_data_t *data, uint32_t ui);
736
744PN_EXTERN int pn_data_put_int(pn_data_t *data, int32_t i);
745
753PN_EXTERN int pn_data_put_char(pn_data_t *data, pn_char_t c);
754
762PN_EXTERN int pn_data_put_ulong(pn_data_t *data, uint64_t ul);
763
771PN_EXTERN int pn_data_put_long(pn_data_t *data, int64_t l);
772
780PN_EXTERN int pn_data_put_timestamp(pn_data_t *data, pn_timestamp_t t);
781
789PN_EXTERN int pn_data_put_float(pn_data_t *data, float f);
790
798PN_EXTERN int pn_data_put_double(pn_data_t *data, double d);
799
807PN_EXTERN int pn_data_put_decimal32(pn_data_t *data, pn_decimal32_t d);
808
816PN_EXTERN int pn_data_put_decimal64(pn_data_t *data, pn_decimal64_t d);
817
825PN_EXTERN int pn_data_put_decimal128(pn_data_t *data, pn_decimal128_t d);
826
834PN_EXTERN int pn_data_put_uuid(pn_data_t *data, pn_uuid_t u);
835
844PN_EXTERN int pn_data_put_binary(pn_data_t *data, pn_bytes_t bytes);
845
854PN_EXTERN int pn_data_put_string(pn_data_t *data, pn_bytes_t string);
855
864PN_EXTERN int pn_data_put_symbol(pn_data_t *data, pn_bytes_t symbol);
865
873PN_EXTERN int pn_data_put_atom(pn_data_t *data, pn_atom_t atom);
874
902PN_EXTERN size_t pn_data_get_list(pn_data_t *data);
903
942PN_EXTERN size_t pn_data_get_map(pn_data_t *data);
943
977PN_EXTERN size_t pn_data_get_array(pn_data_t *data);
978
985PN_EXTERN bool pn_data_is_array_described(pn_data_t *data);
986
994PN_EXTERN pn_type_t pn_data_get_array_type(pn_data_t *data);
995
1019PN_EXTERN bool pn_data_is_described(pn_data_t *data);
1020
1027PN_EXTERN bool pn_data_is_null(pn_data_t *data);
1028
1034PN_EXTERN bool pn_data_get_bool(pn_data_t *data);
1035
1042PN_EXTERN uint8_t pn_data_get_ubyte(pn_data_t *data);
1043
1050PN_EXTERN int8_t pn_data_get_byte(pn_data_t *data);
1051
1058PN_EXTERN uint16_t pn_data_get_ushort(pn_data_t *data);
1059
1066PN_EXTERN int16_t pn_data_get_short(pn_data_t *data);
1067
1074PN_EXTERN uint32_t pn_data_get_uint(pn_data_t *data);
1075
1082PN_EXTERN int32_t pn_data_get_int(pn_data_t *data);
1083
1090PN_EXTERN pn_char_t pn_data_get_char(pn_data_t *data);
1091
1098PN_EXTERN uint64_t pn_data_get_ulong(pn_data_t *data);
1099
1106PN_EXTERN int64_t pn_data_get_long(pn_data_t *data);
1107
1114PN_EXTERN pn_timestamp_t pn_data_get_timestamp(pn_data_t *data);
1115
1122PN_EXTERN float pn_data_get_float(pn_data_t *data);
1123
1130PN_EXTERN double pn_data_get_double(pn_data_t *data);
1131
1138PN_EXTERN pn_decimal32_t pn_data_get_decimal32(pn_data_t *data);
1139
1146PN_EXTERN pn_decimal64_t pn_data_get_decimal64(pn_data_t *data);
1147
1154PN_EXTERN pn_decimal128_t pn_data_get_decimal128(pn_data_t *data);
1155
1163PN_EXTERN pn_uuid_t pn_data_get_uuid(pn_data_t *data);
1164
1173PN_EXTERN pn_bytes_t pn_data_get_binary(pn_data_t *data);
1174
1184PN_EXTERN pn_bytes_t pn_data_get_string(pn_data_t *data);
1185
1195PN_EXTERN pn_bytes_t pn_data_get_symbol(pn_data_t *data);
1196
1206PN_EXTERN pn_bytes_t pn_data_get_bytes(pn_data_t *data);
1207
1214PN_EXTERN pn_atom_t pn_data_get_atom(pn_data_t *data);
1215
1224PN_EXTERN int pn_data_copy(pn_data_t *data, pn_data_t *src);
1225
1233PN_EXTERN int pn_data_append(pn_data_t *data, pn_data_t *src);
1234
1244PN_EXTERN int pn_data_appendn(pn_data_t *data, pn_data_t *src, int limit);
1245
1256PN_EXTERN void pn_data_narrow(pn_data_t *data);
1257
1263PN_EXTERN void pn_data_widen(pn_data_t *data);
1264
1272PN_EXTERN pn_handle_t pn_data_point(pn_data_t *data);
1273
1285PN_EXTERN bool pn_data_restore(pn_data_t *data, pn_handle_t point);
1286
1294PN_EXTERN void pn_data_dump(pn_data_t *data);
1295
1299
1300#ifdef __cplusplus
1301}
1302#endif
1303
1304#endif /* codec.h */
A Proton API error.
uint32_t pn_decimal32_t
A 32-bit decimal floating-point number.
Definition types.h:191
uint64_t pn_decimal64_t
A 64-bit decimal floating-point number.
Definition types.h:198
uint32_t pn_char_t
A 32-bit Unicode code point.
Definition types.h:184
int64_t pn_timestamp_t
A 64-bit timestamp in milliseconds since the Unix epoch.
Definition types.h:177
A 128-bit decimal floating-point number.
Definition types.h:205
A 16-byte universally unique identifier.
Definition types.h:214
A const byte buffer.
Definition types.h:223
struct pn_error_t pn_error_t
An int error code and some string text to describe the error.
Definition error.h:45
AMQP and API data types.
const void * pn_handle_t
A type to represent the internal navigational state of a proton object.
Definition types.h:482