C AMQP Protocol Engine API  0.7
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups 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 #include <proton/type_compat.h>
30 #include <stdarg.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 typedef enum {
37  PN_NULL = 1,
38  PN_BOOL = 2,
39  PN_UBYTE = 3,
40  PN_BYTE = 4,
41  PN_USHORT = 5,
42  PN_SHORT = 6,
43  PN_UINT = 7,
44  PN_INT = 8,
45  PN_CHAR = 9,
46  PN_ULONG = 10,
47  PN_LONG = 11,
49  PN_FLOAT = 13,
50  PN_DOUBLE = 14,
54  PN_UUID = 18,
55  PN_BINARY = 19,
56  PN_STRING = 20,
57  PN_SYMBOL = 21,
59  PN_ARRAY = 23,
60  PN_LIST = 24,
61  PN_MAP = 25
62 } pn_type_t;
63 
64 PN_EXTERN const char *pn_type_name(pn_type_t type);
65 
66 typedef struct {
68  union {
69  bool as_bool;
70  uint8_t as_ubyte;
71  int8_t as_byte;
72  uint16_t as_ushort;
73  int16_t as_short;
74  uint32_t as_uint;
75  int32_t as_int;
77  uint64_t as_ulong;
78  int64_t as_long;
80  float as_float;
81  double as_double;
87  } u;
88 } pn_atom_t;
89 
90 // data
91 
92 typedef struct pn_data_t pn_data_t;
93 
94 PN_EXTERN pn_data_t *pn_data(size_t capacity);
95 PN_EXTERN void pn_data_free(pn_data_t *data);
98 PN_EXTERN int pn_data_vfill(pn_data_t *data, const char *fmt, va_list ap);
99 PN_EXTERN int pn_data_fill(pn_data_t *data, const char *fmt, ...);
100 PN_EXTERN int pn_data_vscan(pn_data_t *data, const char *fmt, va_list ap);
101 PN_EXTERN int pn_data_scan(pn_data_t *data, const char *fmt, ...);
102 
103 PN_EXTERN void pn_data_clear(pn_data_t *data);
104 PN_EXTERN size_t pn_data_size(pn_data_t *data);
106 PN_EXTERN bool pn_data_next(pn_data_t *data);
107 PN_EXTERN bool pn_data_prev(pn_data_t *data);
108 PN_EXTERN bool pn_data_enter(pn_data_t *data);
109 PN_EXTERN bool pn_data_exit(pn_data_t *data);
110 PN_EXTERN bool pn_data_lookup(pn_data_t *data, const char *name);
111 
113 
115 PN_EXTERN int pn_data_format(pn_data_t *data, char *bytes, size_t *size);
116 PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size);
117 PN_EXTERN ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size);
118 
121 PN_EXTERN int pn_data_put_array(pn_data_t *data, bool described, pn_type_t type);
124 PN_EXTERN int pn_data_put_bool(pn_data_t *data, bool b);
125 PN_EXTERN int pn_data_put_ubyte(pn_data_t *data, uint8_t ub);
126 PN_EXTERN int pn_data_put_byte(pn_data_t *data, int8_t b);
127 PN_EXTERN int pn_data_put_ushort(pn_data_t *data, uint16_t us);
128 PN_EXTERN int pn_data_put_short(pn_data_t *data, int16_t s);
129 PN_EXTERN int pn_data_put_uint(pn_data_t *data, uint32_t ui);
130 PN_EXTERN int pn_data_put_int(pn_data_t *data, int32_t i);
132 PN_EXTERN int pn_data_put_ulong(pn_data_t *data, uint64_t ul);
133 PN_EXTERN int pn_data_put_long(pn_data_t *data, int64_t l);
135 PN_EXTERN int pn_data_put_float(pn_data_t *data, float f);
136 PN_EXTERN int pn_data_put_double(pn_data_t *data, double d);
145 
146 PN_EXTERN size_t pn_data_get_list(pn_data_t *data);
147 PN_EXTERN size_t pn_data_get_map(pn_data_t *data);
154 PN_EXTERN uint8_t pn_data_get_ubyte(pn_data_t *data);
155 PN_EXTERN int8_t pn_data_get_byte(pn_data_t *data);
156 PN_EXTERN uint16_t pn_data_get_ushort(pn_data_t *data);
157 PN_EXTERN int16_t pn_data_get_short(pn_data_t *data);
158 PN_EXTERN uint32_t pn_data_get_uint(pn_data_t *data);
159 PN_EXTERN int32_t pn_data_get_int(pn_data_t *data);
161 PN_EXTERN uint64_t pn_data_get_ulong(pn_data_t *data);
162 PN_EXTERN int64_t pn_data_get_long(pn_data_t *data);
175 
176 PN_EXTERN int pn_data_copy(pn_data_t *data, pn_data_t *src);
178 PN_EXTERN int pn_data_appendn(pn_data_t *data, pn_data_t *src, int limit);
180 PN_EXTERN void pn_data_widen(pn_data_t *data);
183 
184 
185 PN_EXTERN void pn_data_dump(pn_data_t *data);
186 
187 #ifdef __cplusplus
188 }
189 #endif
190 
191 #endif /* codec.h */