Qpid Proton C API  0.17.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
codec.h File Reference

AMQP data encoding and decoding. More...

#include <proton/import_export.h>
#include <proton/object.h>
#include <proton/types.h>
#include <proton/error.h>
#include <proton/type_compat.h>
#include <stdarg.h>

Go to the source code of this file.

Classes

struct  pn_atom_t
 A descriminated union that holds any scalar AMQP value. More...
 

Typedefs

typedef struct pn_data_t pn_data_t
 An AMQP Data object. More...
 

Enumerations

enum  pn_type_t {
  PN_NULL, PN_BOOL, PN_UBYTE, PN_BYTE,
  PN_USHORT, PN_SHORT, PN_UINT, PN_INT,
  PN_CHAR, PN_ULONG, PN_LONG, PN_TIMESTAMP,
  PN_FLOAT, PN_DOUBLE, PN_DECIMAL32, PN_DECIMAL64,
  PN_DECIMAL128, PN_UUID, PN_BINARY, PN_STRING,
  PN_SYMBOL, PN_DESCRIBED, PN_ARRAY, PN_LIST,
  PN_MAP, PN_INVALID
}
 Identifies an AMQP type. More...
 

Functions

const char * pn_type_name (pn_type_t type)
 Return a string name for an AMQP type. More...
 
pn_data_tpn_data (size_t capacity)
 Construct a pn_data_t object with the supplied initial capacity. More...
 
void pn_data_free (pn_data_t *data)
 Free a pn_data_t object. More...
 
int pn_data_errno (pn_data_t *data)
 Access the current error code for a given pn_data_t. More...
 
pn_error_tpn_data_error (pn_data_t *data)
 Access the current error for a givn pn_data_t. More...
 
void pn_data_clear (pn_data_t *data)
 Clears a pn_data_t object. More...
 
size_t pn_data_size (pn_data_t *data)
 Returns the total number of nodes contained in a pn_data_t object. More...
 
void pn_data_rewind (pn_data_t *data)
 Clears current node pointer and sets the parent to the root node. More...
 
bool pn_data_next (pn_data_t *data)
 Advances the current node to its next sibling and returns true. More...
 
bool pn_data_prev (pn_data_t *data)
 Moves the current node to its previous sibling and returns true. More...
 
bool pn_data_enter (pn_data_t *data)
 Sets the parent node to the current node and clears the current node. More...
 
bool pn_data_exit (pn_data_t *data)
 Sets the current node to the parent node and the parent node to its own parent. More...
 
pn_type_t pn_data_type (pn_data_t *data)
 Access the type of the current node. More...
 
int pn_data_print (pn_data_t *data)
 Prints the contents of a pn_data_t object using pn_data_format() to stdout. More...
 
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 location. More...
 
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. More...
 
ssize_t pn_data_encoded_size (pn_data_t *data)
 Returns the number of bytes needed to encode a data object. More...
 
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. More...
 
int pn_data_put_list (pn_data_t *data)
 Puts an empty list value into a pn_data_t. More...
 
int pn_data_put_map (pn_data_t *data)
 Puts an empty map value into a pn_data_t. More...
 
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. More...
 
int pn_data_put_described (pn_data_t *data)
 Puts a described value into a pn_data_t object. More...
 
int pn_data_put_null (pn_data_t *data)
 Puts a PN_NULL value. More...
 
int pn_data_put_bool (pn_data_t *data, bool b)
 Puts a PN_BOOL value. More...
 
int pn_data_put_ubyte (pn_data_t *data, uint8_t ub)
 Puts a PN_UBYTE value. More...
 
int pn_data_put_byte (pn_data_t *data, int8_t b)
 Puts a PN_BYTE value. More...
 
int pn_data_put_ushort (pn_data_t *data, uint16_t us)
 Puts a PN_USHORT value. More...
 
int pn_data_put_short (pn_data_t *data, int16_t s)
 Puts a PN_SHORT value. More...
 
int pn_data_put_uint (pn_data_t *data, uint32_t ui)
 Puts a PN_UINT value. More...
 
int pn_data_put_int (pn_data_t *data, int32_t i)
 Puts a PN_INT value. More...
 
int pn_data_put_char (pn_data_t *data, pn_char_t c)
 Puts a PN_CHAR value. More...
 
int pn_data_put_ulong (pn_data_t *data, uint64_t ul)
 Puts a PN_ULONG value. More...
 
int pn_data_put_long (pn_data_t *data, int64_t l)
 Puts a PN_LONG value. More...
 
int pn_data_put_timestamp (pn_data_t *data, pn_timestamp_t t)
 Puts a PN_TIMESTAMP value. More...
 
int pn_data_put_float (pn_data_t *data, float f)
 Puts a PN_FLOAT value. More...
 
int pn_data_put_double (pn_data_t *data, double d)
 Puts a PN_DOUBLE value. More...
 
int pn_data_put_decimal32 (pn_data_t *data, pn_decimal32_t d)
 Puts a PN_DECIMAL32 value. More...
 
int pn_data_put_decimal64 (pn_data_t *data, pn_decimal64_t d)
 Puts a PN_DECIMAL64 value. More...
 
int pn_data_put_decimal128 (pn_data_t *data, pn_decimal128_t d)
 Puts a PN_DECIMAL128 value. More...
 
int pn_data_put_uuid (pn_data_t *data, pn_uuid_t u)
 Puts a PN_UUID value. More...
 
int pn_data_put_binary (pn_data_t *data, pn_bytes_t bytes)
 Puts a PN_BINARY value. More...
 
int pn_data_put_string (pn_data_t *data, pn_bytes_t string)
 Puts a PN_STRING value. More...
 
int pn_data_put_symbol (pn_data_t *data, pn_bytes_t symbol)
 Puts a PN_SYMBOL value. More...
 
int pn_data_put_atom (pn_data_t *data, pn_atom_t atom)
 Puts any scalar value value. More...
 
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. More...
 
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. More...
 
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. More...
 
bool pn_data_is_array_described (pn_data_t *data)
 Returns true if the current node points to a described array. More...
 
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. More...
 
bool pn_data_is_described (pn_data_t *data)
 Checks if the current node is a described value. More...
 
bool pn_data_is_null (pn_data_t *data)
 Checks if the current node is a PN_NULL. More...
 
bool pn_data_get_bool (pn_data_t *data)
 If the current node is a PN_BOOL, returns its value. More...
 
uint8_t pn_data_get_ubyte (pn_data_t *data)
 If the current node is a PN_UBYTE, return its value, otherwise return 0. More...
 
int8_t pn_data_get_byte (pn_data_t *data)
 If the current node is a signed byte, returns its value, returns 0 otherwise. More...
 
uint16_t pn_data_get_ushort (pn_data_t *data)
 If the current node is an unsigned short, returns its value, returns 0 otherwise. More...
 
int16_t pn_data_get_short (pn_data_t *data)
 If the current node is a signed short, returns its value, returns 0 otherwise. More...
 
uint32_t pn_data_get_uint (pn_data_t *data)
 If the current node is an unsigned int, returns its value, returns 0 otherwise. More...
 
int32_t pn_data_get_int (pn_data_t *data)
 If the current node is a signed int, returns its value, returns 0 otherwise. More...
 
pn_char_t pn_data_get_char (pn_data_t *data)
 If the current node is a char, returns its value, returns 0 otherwise. More...
 
uint64_t pn_data_get_ulong (pn_data_t *data)
 If the current node is an unsigned long, returns its value, returns 0 otherwise. More...
 
int64_t pn_data_get_long (pn_data_t *data)
 If the current node is an signed long, returns its value, returns 0 otherwise. More...
 
pn_timestamp_t pn_data_get_timestamp (pn_data_t *data)
 If the current node is a timestamp, returns its value, returns 0 otherwise. More...
 
float pn_data_get_float (pn_data_t *data)
 If the current node is a float, returns its value, raises 0 otherwise. More...
 
double pn_data_get_double (pn_data_t *data)
 If the current node is a double, returns its value, returns 0 otherwise. More...
 
pn_decimal32_t pn_data_get_decimal32 (pn_data_t *data)
 If the current node is a decimal32, returns its value, returns 0 otherwise. More...
 
pn_decimal64_t pn_data_get_decimal64 (pn_data_t *data)
 If the current node is a decimal64, returns its value, returns 0 otherwise. More...
 
pn_decimal128_t pn_data_get_decimal128 (pn_data_t *data)
 If the current node is a decimal128, returns its value, returns 0 otherwise. More...
 
pn_uuid_t pn_data_get_uuid (pn_data_t *data)
 If the current node is a UUID, returns its value, returns None otherwise. More...
 
pn_bytes_t pn_data_get_binary (pn_data_t *data)
 If the current node is binary, returns its value, returns "" otherwise. More...
 
pn_bytes_t pn_data_get_string (pn_data_t *data)
 If the current node is a string, returns its value, returns "" otherwise. More...
 
pn_bytes_t pn_data_get_symbol (pn_data_t *data)
 If the current node is a symbol, returns its value, returns "" otherwise. More...
 
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. More...
 
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. More...
 
int pn_data_copy (pn_data_t *data, pn_data_t *src)
 Copy the contents of another pn_data_t object. More...
 
int pn_data_append (pn_data_t *data, pn_data_t *src)
 Append the contents of another pn_data_t object. More...
 
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. More...
 
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. More...
 
void pn_data_widen (pn_data_t *data)
 Reverse the effect of pn_data_narrow(). More...
 
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 using pn_data_restore(). More...
 
bool pn_data_restore (pn_data_t *data, pn_handle_t point)
 Restores a prior navigational state that was saved using pn_data_point(). More...
 
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 navigational state to stdout for debugging purposes. More...
 

Detailed Description

AMQP data encoding and decoding.