Qpid Proton C 0.37.0
 
Loading...
Searching...
No Matches
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
33extern "C" {
34#endif
35
47typedef enum {
52
57
62
67
72
77
82
86 PN_INT = 8,
87
92
97
102
108
113
118
123
128
133
138
143
149
155
160
165
170
175 PN_MAP = 25,
176
181 PN_INVALID = -1
183
191PN_EXTERN const char *pn_type_name(pn_type_t type);
192
200typedef struct {
206 union {
210 bool as_bool;
211
215 uint8_t as_ubyte;
216
220 int8_t as_byte;
221
225 uint16_t as_ushort;
226
230 int16_t as_short;
231
235 uint32_t as_uint;
236
240 int32_t as_int;
241
245 pn_char_t as_char;
246
250 uint64_t as_ulong;
251
255 int64_t as_long;
256
260 pn_timestamp_t as_timestamp;
261
265 float as_float;
266
270 double as_double;
271
275 pn_decimal32_t as_decimal32;
276
280 pn_decimal64_t as_decimal64;
281
285 pn_decimal128_t as_decimal128;
286
290 pn_uuid_t as_uuid;
291
299 pn_bytes_t as_bytes;
300 } u;
301} pn_atom_t;
302
313
375typedef struct pn_data_t pn_data_t;
376
385PN_EXTERN pn_data_t *pn_data(size_t capacity);
386
392PN_EXTERN void pn_data_free(pn_data_t *data);
393
400PN_EXTERN int pn_data_errno(pn_data_t *data);
401
414
418PN_EXTERN int pn_data_vfill(pn_data_t *data, const char *fmt, va_list ap);
419PN_EXTERN int pn_data_fill(pn_data_t *data, const char *fmt, ...);
420PN_EXTERN int pn_data_vscan(pn_data_t *data, const char *fmt, va_list ap);
421PN_EXTERN int pn_data_scan(pn_data_t *data, const char *fmt, ...);
434PN_EXTERN void pn_data_clear(pn_data_t *data);
435
445PN_EXTERN size_t pn_data_size(pn_data_t *data);
446
452PN_EXTERN void pn_data_rewind(pn_data_t *data);
453
462PN_EXTERN bool pn_data_next(pn_data_t *data);
463
472PN_EXTERN bool pn_data_prev(pn_data_t *data);
473
484PN_EXTERN bool pn_data_enter(pn_data_t *data);
485
495PN_EXTERN bool pn_data_exit(pn_data_t *data);
496
500PN_EXTERN bool pn_data_lookup(pn_data_t *data, const char *name);
513
521PN_EXTERN int pn_data_print(pn_data_t *data);
522
534PN_EXTERN int pn_data_format(pn_data_t *data, char *bytes, size_t *size);
535
546PN_EXTERN ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size);
547
555PN_EXTERN ssize_t pn_data_encoded_size(pn_data_t *data);
556
574PN_EXTERN ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size);
575
598PN_EXTERN int pn_data_put_list(pn_data_t *data);
599
618PN_EXTERN int pn_data_put_map(pn_data_t *data);
619
653PN_EXTERN int pn_data_put_array(pn_data_t *data, bool described, pn_type_t type);
654
674PN_EXTERN int pn_data_put_described(pn_data_t *data);
675
682PN_EXTERN int pn_data_put_null(pn_data_t *data);
683
691PN_EXTERN int pn_data_put_bool(pn_data_t *data, bool b);
692
700PN_EXTERN int pn_data_put_ubyte(pn_data_t *data, uint8_t ub);
701
709PN_EXTERN int pn_data_put_byte(pn_data_t *data, int8_t b);
710
718PN_EXTERN int pn_data_put_ushort(pn_data_t *data, uint16_t us);
719
727PN_EXTERN int pn_data_put_short(pn_data_t *data, int16_t s);
728
736PN_EXTERN int pn_data_put_uint(pn_data_t *data, uint32_t ui);
737
745PN_EXTERN int pn_data_put_int(pn_data_t *data, int32_t i);
746
754PN_EXTERN int pn_data_put_char(pn_data_t *data, pn_char_t c);
755
763PN_EXTERN int pn_data_put_ulong(pn_data_t *data, uint64_t ul);
764
772PN_EXTERN int pn_data_put_long(pn_data_t *data, int64_t l);
773
782
790PN_EXTERN int pn_data_put_float(pn_data_t *data, float f);
791
799PN_EXTERN int pn_data_put_double(pn_data_t *data, double d);
800
809
818
827
835PN_EXTERN int pn_data_put_uuid(pn_data_t *data, pn_uuid_t u);
836
845PN_EXTERN int pn_data_put_binary(pn_data_t *data, pn_bytes_t bytes);
846
855PN_EXTERN int pn_data_put_string(pn_data_t *data, pn_bytes_t string);
856
865PN_EXTERN int pn_data_put_symbol(pn_data_t *data, pn_bytes_t symbol);
866
874PN_EXTERN int pn_data_put_atom(pn_data_t *data, pn_atom_t atom);
875
903PN_EXTERN size_t pn_data_get_list(pn_data_t *data);
904
943PN_EXTERN size_t pn_data_get_map(pn_data_t *data);
944
978PN_EXTERN size_t pn_data_get_array(pn_data_t *data);
979
987
996
1020PN_EXTERN bool pn_data_is_described(pn_data_t *data);
1021
1028PN_EXTERN bool pn_data_is_null(pn_data_t *data);
1029
1035PN_EXTERN bool pn_data_get_bool(pn_data_t *data);
1036
1043PN_EXTERN uint8_t pn_data_get_ubyte(pn_data_t *data);
1044
1051PN_EXTERN int8_t pn_data_get_byte(pn_data_t *data);
1052
1059PN_EXTERN uint16_t pn_data_get_ushort(pn_data_t *data);
1060
1067PN_EXTERN int16_t pn_data_get_short(pn_data_t *data);
1068
1075PN_EXTERN uint32_t pn_data_get_uint(pn_data_t *data);
1076
1083PN_EXTERN int32_t pn_data_get_int(pn_data_t *data);
1084
1092
1099PN_EXTERN uint64_t pn_data_get_ulong(pn_data_t *data);
1100
1107PN_EXTERN int64_t pn_data_get_long(pn_data_t *data);
1108
1116
1123PN_EXTERN float pn_data_get_float(pn_data_t *data);
1124
1131PN_EXTERN double pn_data_get_double(pn_data_t *data);
1132
1140
1148
1156
1165
1175
1186
1197
1208
1216
1225PN_EXTERN int pn_data_copy(pn_data_t *data, pn_data_t *src);
1226
1234PN_EXTERN int pn_data_append(pn_data_t *data, pn_data_t *src);
1235
1245PN_EXTERN int pn_data_appendn(pn_data_t *data, pn_data_t *src, int limit);
1246
1257PN_EXTERN void pn_data_narrow(pn_data_t *data);
1258
1264PN_EXTERN void pn_data_widen(pn_data_t *data);
1265
1273PN_EXTERN pn_handle_t pn_data_point(pn_data_t *data);
1274
1286PN_EXTERN bool pn_data_restore(pn_data_t *data, pn_handle_t point);
1287
1295PN_EXTERN void pn_data_dump(pn_data_t *data);
1296
1301#ifdef __cplusplus
1302}
1303#endif
1304
1305#endif /* codec.h */
A Proton API error.
pn_type_t
Identifies an AMQP type.
Definition codec.h:47
uint32_t pn_decimal32_t
A 32-bit decimal floating-point number.
Definition types.h:184
uint64_t pn_decimal64_t
A 64-bit decimal floating-point number.
Definition types.h:191
uint32_t pn_char_t
A 32-bit Unicode code point.
Definition types.h:177
int64_t pn_timestamp_t
A 64-bit timestamp in milliseconds since the Unix epoch.
Definition types.h:170
const char * pn_type_name(pn_type_t type)
Return a string name for an AMQP type.
@ PN_UUID
The UUID AMQP type.
Definition codec.h:137
@ PN_INT
The signed int AMQP type.
Definition codec.h:86
@ PN_ARRAY
An AMQP array.
Definition codec.h:164
@ PN_BOOL
The boolean AMQP type.
Definition codec.h:56
@ PN_MAP
An AMQP map.
Definition codec.h:175
@ PN_BYTE
The byte AMQP type.
Definition codec.h:66
@ PN_SHORT
The short AMQP type.
Definition codec.h:76
@ PN_ULONG
The ulong AMQP type.
Definition codec.h:96
@ PN_LIST
An AMQP list.
Definition codec.h:169
@ PN_USHORT
The unsigned short AMQP type.
Definition codec.h:71
@ PN_LONG
The long AMQP type.
Definition codec.h:101
@ PN_BINARY
The binary AMQP type.
Definition codec.h:142
@ PN_STRING
The string AMQP type.
Definition codec.h:148
@ PN_INVALID
A special invalid type value that is returned when no valid type is available.
Definition codec.h:181
@ PN_CHAR
The char AMQP type.
Definition codec.h:91
@ PN_UBYTE
The unsigned byte AMQP type.
Definition codec.h:61
@ PN_FLOAT
The float AMQP type.
Definition codec.h:112
@ PN_DOUBLE
The double AMQP type.
Definition codec.h:117
@ PN_UINT
The unsigned int AMQP type.
Definition codec.h:81
@ PN_TIMESTAMP
The timestamp AMQP type.
Definition codec.h:107
@ PN_DECIMAL64
The decimal64 AMQP type.
Definition codec.h:127
@ PN_SYMBOL
The symbol AMQP type.
Definition codec.h:154
@ PN_DECIMAL128
The decimal128 AMQP type.
Definition codec.h:132
@ PN_DECIMAL32
The decimal32 AMQP type.
Definition codec.h:122
@ PN_NULL
The NULL AMQP type.
Definition codec.h:51
@ PN_DESCRIBED
A described AMQP type.
Definition codec.h:159
A 128-bit decimal floating-point number.
Definition types.h:198
A 16-byte universally unique identifier.
Definition types.h:207
pn_type_t type
Indicates the type of value the atom is currently pointing to.
Definition codec.h:205
pn_atom_t pn_msgid_t
A type that holds scalar AMQP values that are valid for message id and correlation id fields.
Definition codec.h:312
A discriminated union that holds any scalar AMQP value.
Definition codec.h:200
A const byte buffer.
Definition types.h:216
int pn_data_put_symbol(pn_data_t *data, pn_bytes_t symbol)
Puts a PN_SYMBOL value.
int pn_data_put_decimal32(pn_data_t *data, pn_decimal32_t d)
Puts a PN_DECIMAL32 value.
int pn_data_append(pn_data_t *data, pn_data_t *src)
Append the contents of another pn_data_t object.
bool pn_data_enter(pn_data_t *data)
Sets the parent node to the current node and clears the current node.
pn_type_t pn_data_get_array_type(pn_data_t *data)
Return the array type if the current node points to an array, PN_INVALID otherwise.
int pn_data_put_double(pn_data_t *data, double d)
Puts a PN_DOUBLE value.
bool pn_data_is_array_described(pn_data_t *data)
Returns true if the current node points to a described array.
size_t pn_data_size(pn_data_t *data)
Returns the total number of nodes contained in a pn_data_t object.
int pn_data_put_byte(pn_data_t *data, int8_t b)
Puts a PN_BYTE value.
int pn_data_put_float(pn_data_t *data, float f)
Puts a PN_FLOAT value.
int pn_data_put_array(pn_data_t *data, bool described, pn_type_t type)
Puts an empty array value into a pn_data_t.
uint16_t pn_data_get_ushort(pn_data_t *data)
If the current node is an unsigned short, returns its value, returns 0 otherwise.
void pn_data_rewind(pn_data_t *data)
Clears current node pointer and sets the parent to the root node.
pn_type_t pn_data_type(pn_data_t *data)
Access the type of the current node.
void pn_data_free(pn_data_t *data)
Free a pn_data_t object.
size_t pn_data_get_list(pn_data_t *data)
If the current node is a list, return the number of elements, otherwise return zero.
pn_decimal64_t pn_data_get_decimal64(pn_data_t *data)
If the current node is a decimal64, returns its value, returns 0 otherwise.
pn_bytes_t pn_data_get_symbol(pn_data_t *data)
If the current node is a symbol, returns its value, returns "" otherwise.
int pn_data_put_ubyte(pn_data_t *data, uint8_t ub)
Puts a PN_UBYTE value.
int pn_data_put_bool(pn_data_t *data, bool b)
Puts a PN_BOOL value.
int pn_data_put_map(pn_data_t *data)
Puts an empty map value into a pn_data_t.
int32_t pn_data_get_int(pn_data_t *data)
If the current node is a signed int, returns its value, returns 0 otherwise.
void pn_data_dump(pn_data_t *data)
Dumps a debug representation of the internal state of the pn_data_t object that includes its navigati...
int pn_data_put_uint(pn_data_t *data, uint32_t ui)
Puts a PN_UINT value.
ssize_t pn_data_encode(pn_data_t *data, char *bytes, size_t size)
Writes the contents of a data object to the given buffer as an AMQP data stream.
pn_uuid_t pn_data_get_uuid(pn_data_t *data)
If the current node is a UUID, returns its value, returns None otherwise.
struct pn_data_t pn_data_t
An AMQP Data object.
Definition codec.h:375
int pn_data_put_uuid(pn_data_t *data, pn_uuid_t u)
Puts a PN_UUID value.
int pn_data_put_string(pn_data_t *data, pn_bytes_t string)
Puts a PN_STRING value.
pn_handle_t pn_data_point(pn_data_t *data)
Returns a handle for the current navigational state of a pn_data_t so that it can be later restored u...
int pn_data_put_decimal128(pn_data_t *data, pn_decimal128_t d)
Puts a PN_DECIMAL128 value.
bool pn_data_exit(pn_data_t *data)
Sets the current node to the parent node and the parent node to its own parent.
int pn_data_errno(pn_data_t *data)
Access the current error code for a given pn_data_t.
int pn_data_put_int(pn_data_t *data, int32_t i)
Puts a PN_INT value.
ssize_t pn_data_decode(pn_data_t *data, const char *bytes, size_t size)
Decodes a single value from the contents of the AMQP data stream into the current data object.
int pn_data_put_described(pn_data_t *data)
Puts a described value into a pn_data_t object.
uint8_t pn_data_get_ubyte(pn_data_t *data)
If the current node is a PN_UBYTE, return its value, otherwise return 0.
void pn_data_clear(pn_data_t *data)
Clears a pn_data_t object.
int pn_data_put_decimal64(pn_data_t *data, pn_decimal64_t d)
Puts a PN_DECIMAL64 value.
int64_t pn_data_get_long(pn_data_t *data)
If the current node is an signed long, returns its value, returns 0 otherwise.
int pn_data_put_long(pn_data_t *data, int64_t l)
Puts a PN_LONG value.
bool pn_data_restore(pn_data_t *data, pn_handle_t point)
Restores a prior navigational state that was saved using pn_data_point().
int pn_data_put_atom(pn_data_t *data, pn_atom_t atom)
Puts any scalar value value.
uint32_t pn_data_get_uint(pn_data_t *data)
If the current node is an unsigned int, returns its value, returns 0 otherwise.
int pn_data_put_list(pn_data_t *data)
Puts an empty list value into a pn_data_t.
bool pn_data_next(pn_data_t *data)
Advances the current node to its next sibling and returns true.
double pn_data_get_double(pn_data_t *data)
If the current node is a double, returns its value, returns 0 otherwise.
int pn_data_appendn(pn_data_t *data, pn_data_t *src, int limit)
Append up to n values from the contents of another pn_data_t object.
int pn_data_put_ushort(pn_data_t *data, uint16_t us)
Puts a PN_USHORT value.
pn_char_t pn_data_get_char(pn_data_t *data)
If the current node is a char, returns its value, returns 0 otherwise.
bool pn_data_prev(pn_data_t *data)
Moves the current node to its previous sibling and returns true.
int pn_data_format(pn_data_t *data, char *bytes, size_t *size)
Formats the contents of a pn_data_t object in a human readable way and writes them to the indicated l...
int8_t pn_data_get_byte(pn_data_t *data)
If the current node is a signed byte, returns its value, returns 0 otherwise.
void pn_data_narrow(pn_data_t *data)
Modify a pn_data_t object to behave as if the current node is the root node of the tree.
int pn_data_print(pn_data_t *data)
Prints the contents of a pn_data_t object using pn_data_format() to stdout.
size_t pn_data_get_array(pn_data_t *data)
If the current node is an array, return the number of elements in the array, otherwise return 0.
int pn_data_put_short(pn_data_t *data, int16_t s)
Puts a PN_SHORT value.
pn_data_t * pn_data(size_t capacity)
Construct a pn_data_t object with the supplied initial capacity.
void pn_data_widen(pn_data_t *data)
Reverse the effect of pn_data_narrow().
bool pn_data_is_null(pn_data_t *data)
Checks if the current node is a PN_NULL.
pn_decimal32_t pn_data_get_decimal32(pn_data_t *data)
If the current node is a decimal32, returns its value, returns 0 otherwise.
pn_error_t * pn_data_error(pn_data_t *data)
Access the current error for a given pn_data_t.
float pn_data_get_float(pn_data_t *data)
If the current node is a float, returns its value, returns 0 otherwise.
pn_atom_t pn_data_get_atom(pn_data_t *data)
If the current node is a scalar value, return it as a pn_atom_t.
pn_timestamp_t pn_data_get_timestamp(pn_data_t *data)
If the current node is a timestamp, returns its value, returns 0 otherwise.
int pn_data_put_timestamp(pn_data_t *data, pn_timestamp_t t)
Puts a PN_TIMESTAMP value.
int pn_data_put_ulong(pn_data_t *data, uint64_t ul)
Puts a PN_ULONG value.
pn_bytes_t pn_data_get_bytes(pn_data_t *data)
If the current node is a symbol, string, or binary, return the bytes representing its value.
int pn_data_put_char(pn_data_t *data, pn_char_t c)
Puts a PN_CHAR value.
bool pn_data_is_described(pn_data_t *data)
Checks if the current node is a described value.
size_t pn_data_get_map(pn_data_t *data)
If the current node is a map, return the number of child elements, otherwise return zero.
ssize_t pn_data_encoded_size(pn_data_t *data)
Returns the number of bytes needed to encode a data object.
bool pn_data_get_bool(pn_data_t *data)
If the current node is a PN_BOOL, returns its value.
pn_decimal128_t pn_data_get_decimal128(pn_data_t *data)
If the current node is a decimal128, returns its value, returns 0 otherwise.
int pn_data_put_binary(pn_data_t *data, pn_bytes_t bytes)
Puts a PN_BINARY value.
pn_bytes_t pn_data_get_binary(pn_data_t *data)
If the current node is binary, returns its value, returns "" otherwise.
uint64_t pn_data_get_ulong(pn_data_t *data)
If the current node is an unsigned long, returns its value, returns 0 otherwise.
int pn_data_copy(pn_data_t *data, pn_data_t *src)
Copy the contents of another pn_data_t object.
int pn_data_put_null(pn_data_t *data)
Puts a PN_NULL value.
pn_bytes_t pn_data_get_string(pn_data_t *data)
If the current node is a string, returns its value, returns "" otherwise.
int16_t pn_data_get_short(pn_data_t *data)
If the current node is a signed short, returns its value, returns 0 otherwise.
struct pn_error_t pn_error_t
An int error code and some string text to describe the error.
Definition error.h:44
AMQP and API data types.