proton  0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
codec.h
Go to the documentation of this file.
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/object.h>
27 #include <proton/types.h>
28 #include <proton/error.h>
29 #ifndef __cplusplus
30 #include <stdbool.h>
31 #include <stdint.h>
32 #else
33 #include <proton/type_compat.h>
34 #endif
35 #include <stdarg.h>
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
41 typedef enum {
42  PN_NULL = 1,
43  PN_BOOL = 2,
44  PN_UBYTE = 3,
45  PN_BYTE = 4,
46  PN_USHORT = 5,
47  PN_SHORT = 6,
48  PN_UINT = 7,
49  PN_INT = 8,
50  PN_CHAR = 9,
51  PN_ULONG = 10,
52  PN_LONG = 11,
54  PN_FLOAT = 13,
55  PN_DOUBLE = 14,
59  PN_UUID = 18,
60  PN_BINARY = 19,
61  PN_STRING = 20,
62  PN_SYMBOL = 21,
64  PN_ARRAY = 23,
65  PN_LIST = 24,
66  PN_MAP = 25
67 } pn_type_t;
68 
69 PN_EXTERN const char *pn_type_name(pn_type_t type);
70 
71 typedef struct {
73  union {
74  bool as_bool;
75  uint8_t as_ubyte;
76  int8_t as_byte;
77  uint16_t as_ushort;
78  int16_t as_short;
79  uint32_t as_uint;
80  int32_t as_int;
82  uint64_t as_ulong;
83  int64_t as_long;
85  float as_float;
86  double as_double;
92  } u;
93 } pn_atom_t;
94 
95 // data
96 
97 typedef struct pn_data_t pn_data_t;
98 
99 PN_EXTERN pn_data_t *pn_data(size_t capacity);
100 PN_EXTERN void pn_data_free(pn_data_t *data);
103 PN_EXTERN int pn_data_vfill(pn_data_t *data, const char *fmt, va_list ap);
104 PN_EXTERN int pn_data_fill(pn_data_t *data, const char *fmt, ...);
105 PN_EXTERN int pn_data_vscan(pn_data_t *data, const char *fmt, va_list ap);
106 PN_EXTERN int pn_data_scan(pn_data_t *data, const char *fmt, ...);
107 
108 PN_EXTERN void pn_data_clear(pn_data_t *data);
109 PN_EXTERN size_t pn_data_size(pn_data_t *data);
111 PN_EXTERN bool pn_data_next(pn_data_t *data);
112 PN_EXTERN bool pn_data_prev(pn_data_t *data);
113 PN_EXTERN bool pn_data_enter(pn_data_t *data);
114 PN_EXTERN bool pn_data_exit(pn_data_t *data);
115 PN_EXTERN bool pn_data_lookup(pn_data_t *data, const char *name);
116 
118 
120 PN_EXTERN int pn_data_format(pn_data_t *data, char *bytes, size_t *size);
121 PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size);
122 PN_EXTERN ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size);
123 
126 PN_EXTERN int pn_data_put_array(pn_data_t *data, bool described, pn_type_t type);
129 PN_EXTERN int pn_data_put_bool(pn_data_t *data, bool b);
130 PN_EXTERN int pn_data_put_ubyte(pn_data_t *data, uint8_t ub);
131 PN_EXTERN int pn_data_put_byte(pn_data_t *data, int8_t b);
132 PN_EXTERN int pn_data_put_ushort(pn_data_t *data, uint16_t us);
133 PN_EXTERN int pn_data_put_short(pn_data_t *data, int16_t s);
134 PN_EXTERN int pn_data_put_uint(pn_data_t *data, uint32_t ui);
135 PN_EXTERN int pn_data_put_int(pn_data_t *data, int32_t i);
137 PN_EXTERN int pn_data_put_ulong(pn_data_t *data, uint64_t ul);
138 PN_EXTERN int pn_data_put_long(pn_data_t *data, int64_t l);
140 PN_EXTERN int pn_data_put_float(pn_data_t *data, float f);
141 PN_EXTERN int pn_data_put_double(pn_data_t *data, double d);
150 
151 PN_EXTERN size_t pn_data_get_list(pn_data_t *data);
152 PN_EXTERN size_t pn_data_get_map(pn_data_t *data);
159 PN_EXTERN uint8_t pn_data_get_ubyte(pn_data_t *data);
160 PN_EXTERN int8_t pn_data_get_byte(pn_data_t *data);
161 PN_EXTERN uint16_t pn_data_get_ushort(pn_data_t *data);
162 PN_EXTERN int16_t pn_data_get_short(pn_data_t *data);
163 PN_EXTERN uint32_t pn_data_get_uint(pn_data_t *data);
164 PN_EXTERN int32_t pn_data_get_int(pn_data_t *data);
166 PN_EXTERN uint64_t pn_data_get_ulong(pn_data_t *data);
167 PN_EXTERN int64_t pn_data_get_long(pn_data_t *data);
180 
181 PN_EXTERN int pn_data_copy(pn_data_t *data, pn_data_t *src);
183 PN_EXTERN int pn_data_appendn(pn_data_t *data, pn_data_t *src, int limit);
185 PN_EXTERN void pn_data_widen(pn_data_t *data);
188 
189 
190 PN_EXTERN void pn_data_dump(pn_data_t *data);
191 
192 #ifdef __cplusplus
193 }
194 #endif
195 
196 #endif /* codec.h */
PN_EXTERN int32_t pn_data_get_int(pn_data_t *data)
PN_EXTERN pn_decimal128_t pn_data_get_decimal128(pn_data_t *data)
PN_EXTERN int pn_data_put_decimal32(pn_data_t *data, pn_decimal32_t d)
uint16_t as_ushort
Definition: codec.h:77
pn_decimal64_t as_decimal64
Definition: codec.h:88
uint32_t as_uint
Definition: codec.h:79
Definition: codec.h:55
double as_double
Definition: codec.h:86
PN_EXTERN float pn_data_get_float(pn_data_t *data)
PN_EXTERN double pn_data_get_double(pn_data_t *data)
PN_EXTERN pn_bytes_t pn_data_get_string(pn_data_t *data)
PN_EXTERN pn_bytes_t pn_data_get_binary(pn_data_t *data)
uint32_t pn_decimal32_t
Definition: types.h:43
PN_EXTERN int pn_data_put_uuid(pn_data_t *data, pn_uuid_t u)
Definition: codec.h:56
pn_decimal32_t as_decimal32
Definition: codec.h:87
PN_EXTERN pn_data_t * pn_data(size_t capacity)
PN_EXTERN int8_t pn_data_get_byte(pn_data_t *data)
Definition: codec.h:44
PN_EXTERN uint8_t pn_data_get_ubyte(pn_data_t *data)
Definition: codec.h:71
PN_EXTERN void pn_data_rewind(pn_data_t *data)
PN_EXTERN pn_bytes_t pn_data_get_symbol(pn_data_t *data)
int32_t as_int
Definition: codec.h:80
Definition: codec.h:61
PN_EXTERN size_t pn_data_size(pn_data_t *data)
PN_EXTERN bool pn_data_enter(pn_data_t *data)
Definition: codec.h:66
pn_type_t type
Definition: codec.h:72
PN_EXTERN pn_atom_t pn_data_get_atom(pn_data_t *data)
Definition: codec.h:58
PN_EXTERN void pn_data_clear(pn_data_t *data)
PN_EXTERN int pn_data_put_ubyte(pn_data_t *data, uint8_t ub)
PN_EXTERN pn_error_t * pn_data_error(pn_data_t *data)
PN_EXTERN size_t pn_data_get_array(pn_data_t *data)
Definition: codec.h:51
pn_decimal128_t as_decimal128
Definition: codec.h:89
PN_EXTERN int64_t pn_data_get_long(pn_data_t *data)
Definition: codec.h:43
PN_EXTERN int pn_data_put_char(pn_data_t *data, pn_char_t c)
PN_EXTERN int pn_data_append(pn_data_t *data, pn_data_t *src)
PN_EXTERN int pn_data_put_int(pn_data_t *data, int32_t i)
Definition: codec.h:52
PN_EXTERN int pn_data_vscan(pn_data_t *data, const char *fmt, va_list ap)
PN_EXTERN size_t pn_data_get_map(pn_data_t *data)
PN_EXTERN pn_timestamp_t pn_data_get_timestamp(pn_data_t *data)
Definition: codec.h:64
pn_bytes_t as_bytes
Definition: codec.h:91
PN_EXTERN int pn_data_vfill(pn_data_t *data, const char *fmt, va_list ap)
uintptr_t pn_handle_t
Definition: object.h:40
PN_EXTERN pn_bytes_t pn_data_get_bytes(pn_data_t *data)
PN_EXTERN pn_decimal64_t pn_data_get_decimal64(pn_data_t *data)
PN_EXTERN int pn_data_put_array(pn_data_t *data, bool described, pn_type_t type)
Definition: codec.h:45
pn_uuid_t as_uuid
Definition: codec.h:90
Definition: codec.h:65
PN_EXTERN int pn_data_put_atom(pn_data_t *data, pn_atom_t atom)
Definition: codec.h:46
PN_EXTERN int pn_data_put_null(pn_data_t *data)
PN_EXTERN void pn_data_narrow(pn_data_t *data)
uint64_t pn_decimal64_t
Definition: types.h:44
PN_EXTERN pn_type_t pn_data_get_array_type(pn_data_t *data)
PN_EXTERN pn_decimal32_t pn_data_get_decimal32(pn_data_t *data)
PN_EXTERN void pn_data_free(pn_data_t *data)
PN_EXTERN int pn_data_put_described(pn_data_t *data)
uint32_t pn_char_t
Definition: types.h:42
PN_EXTERN int pn_data_put_decimal64(pn_data_t *data, pn_decimal64_t d)
Definition: codec.h:60
pn_type_t
Definition: codec.h:41
PN_EXTERN void pn_data_dump(pn_data_t *data)
PN_EXTERN bool pn_data_is_described(pn_data_t *data)
PN_EXTERN bool pn_data_exit(pn_data_t *data)
PN_EXTERN uint64_t pn_data_get_ulong(pn_data_t *data)
Definition: codec.h:49
PN_EXTERN int pn_data_put_decimal128(pn_data_t *data, pn_decimal128_t d)
PN_EXTERN int pn_data_put_map(pn_data_t *data)
PN_EXTERN int pn_data_appendn(pn_data_t *data, pn_data_t *src, int limit)
struct pn_error_t pn_error_t
Definition: error.h:32
PN_EXTERN const char * pn_type_name(pn_type_t type)
PN_EXTERN int pn_data_put_binary(pn_data_t *data, pn_bytes_t bytes)
struct pn_data_t pn_data_t
Definition: codec.h:97
int64_t as_long
Definition: codec.h:83
PN_EXTERN int pn_data_put_list(pn_data_t *data)
Definition: codec.h:54
PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size)
Definition: codec.h:42
PN_EXTERN int pn_data_put_short(pn_data_t *data, int16_t s)
PN_EXTERN int pn_data_put_float(pn_data_t *data, float f)
PN_EXTERN int pn_data_errno(pn_data_t *data)
PN_EXTERN uint16_t pn_data_get_ushort(pn_data_t *data)
Definition: codec.h:57
PN_EXTERN int pn_data_put_ulong(pn_data_t *data, uint64_t ul)
PN_EXTERN int pn_data_put_long(pn_data_t *data, int64_t l)
int8_t as_byte
Definition: codec.h:76
PN_EXTERN uint32_t pn_data_get_uint(pn_data_t *data)
PN_EXTERN int pn_data_put_symbol(pn_data_t *data, pn_bytes_t symbol)
PN_EXTERN pn_handle_t pn_data_point(pn_data_t *data)
PN_EXTERN pn_uuid_t pn_data_get_uuid(pn_data_t *data)
Definition: codec.h:63
PN_EXTERN int pn_data_fill(pn_data_t *data, const char *fmt,...)
PN_EXTERN bool pn_data_next(pn_data_t *data)
uint64_t as_ulong
Definition: codec.h:82
PN_EXTERN int pn_data_put_ushort(pn_data_t *data, uint16_t us)
Definition: codec.h:59
PN_EXTERN ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size)
PN_EXTERN int pn_data_put_timestamp(pn_data_t *data, pn_timestamp_t t)
PN_EXTERN int pn_data_scan(pn_data_t *data, const char *fmt,...)
Definition: types.h:48
pn_timestamp_t as_timestamp
Definition: codec.h:84
Definition: codec.h:62
Definition: codec.h:47
Definition: codec.h:48
PN_EXTERN int pn_data_put_double(pn_data_t *data, double d)
PN_EXTERN int pn_data_put_uint(pn_data_t *data, uint32_t ui)
uint8_t as_ubyte
Definition: codec.h:75
PN_EXTERN int pn_data_format(pn_data_t *data, char *bytes, size_t *size)
PN_EXTERN int pn_data_print(pn_data_t *data)
#define PN_EXTERN
Definition: import_export.h:53
int16_t as_short
Definition: codec.h:78
PN_EXTERN bool pn_data_is_null(pn_data_t *data)
PN_EXTERN int pn_data_put_string(pn_data_t *data, pn_bytes_t string)
PN_EXTERN int pn_data_put_byte(pn_data_t *data, int8_t b)
PN_EXTERN int16_t pn_data_get_short(pn_data_t *data)
PN_EXTERN void pn_data_widen(pn_data_t *data)
float as_float
Definition: codec.h:85
PN_EXTERN int pn_data_put_bool(pn_data_t *data, bool b)
int64_t pn_timestamp_t
Definition: types.h:41
Definition: types.h:45
PN_EXTERN bool pn_data_prev(pn_data_t *data)
PN_EXTERN size_t pn_data_get_list(pn_data_t *data)
Definition: types.h:52
PN_EXTERN bool pn_data_restore(pn_data_t *data, pn_handle_t point)
PN_EXTERN bool pn_data_is_array_described(pn_data_t *data)
PN_EXTERN bool pn_data_lookup(pn_data_t *data, const char *name)
Definition: codec.h:53
PN_EXTERN bool pn_data_get_bool(pn_data_t *data)
PN_EXTERN pn_char_t pn_data_get_char(pn_data_t *data)
pn_char_t as_char
Definition: codec.h:81
PN_EXTERN int pn_data_copy(pn_data_t *data, pn_data_t *src)
bool as_bool
Definition: codec.h:74
Definition: codec.h:50
PN_EXTERN pn_type_t pn_data_type(pn_data_t *data)