uBlink  0.0.1
TheBlinkProtocol
Functions | Typedefs
blink_compact
ublink

Description

Compact form encode/decode functions.

Functions

bool BLINK_Compact_encodeNull (blink_stream_t out)
 Encode a null. More...
 
bool BLINK_Compact_encodePresent (blink_stream_t out)
 Encode a present symbol. More...
 
bool BLINK_Compact_decodeBool (blink_stream_t in, bool *out, bool *isNull)
 Decode bool More...
 
bool BLINK_Compact_decodeU8 (blink_stream_t in, uint8_t *out, bool *isNull)
 Decode u8 More...
 
bool BLINK_Compact_decodeU16 (blink_stream_t in, uint16_t *out, bool *isNull)
 Decode u16 More...
 
bool BLINK_Compact_decodeU32 (blink_stream_t in, uint32_t *out, bool *isNull)
 Decode u32 More...
 
bool BLINK_Compact_decodeU64 (blink_stream_t in, uint64_t *out, bool *isNull)
 Decode u64 More...
 
bool BLINK_Compact_decodeI8 (blink_stream_t in, int8_t *out, bool *isNull)
 Decode i8 More...
 
bool BLINK_Compact_decodeI16 (blink_stream_t in, int16_t *out, bool *isNull)
 Decode i16 More...
 
bool BLINK_Compact_decodeI32 (blink_stream_t in, int32_t *out, bool *isNull)
 Decode i32 More...
 
bool BLINK_Compact_decodeI64 (blink_stream_t in, int64_t *out, bool *isNull)
 Decode i64 More...
 
bool BLINK_Compact_decodeDecimal (blink_stream_t in, int64_t *mantissa, int8_t *exponent, bool *isNull)
 Decode decimal More...
 
bool BLINK_Compact_decodeF64 (blink_stream_t in, double *out, bool *isNull)
 Decode f64 More...
 
bool BLINK_Compact_decodePresent (blink_stream_t in, bool *out)
 Decode a present field. More...
 
bool BLINK_Compact_encodeBool (bool in, blink_stream_t out)
 Encode bool More...
 
bool BLINK_Compact_encodeU8 (uint8_t in, blink_stream_t out)
 Encode u8 More...
 
bool BLINK_Compact_encodeU16 (uint16_t in, blink_stream_t out)
 Encode u16 More...
 
bool BLINK_Compact_encodeU32 (uint32_t in, blink_stream_t out)
 Encode u32 More...
 
bool BLINK_Compact_encodeU64 (uint64_t in, blink_stream_t out)
 Encode u64 More...
 
bool BLINK_Compact_encodeI8 (int8_t in, blink_stream_t out)
 Encode i8 More...
 
bool BLINK_Compact_encodeI16 (int16_t in, blink_stream_t out)
 Encode i16 More...
 
bool BLINK_Compact_encodeI32 (int32_t in, blink_stream_t out)
 Encode i32 More...
 
bool BLINK_Compact_encodeI64 (int64_t in, blink_stream_t out)
 Encode i64 More...
 
bool BLINK_Compact_encodeF64 (double in, blink_stream_t out)
 Encode f64 More...
 
bool BLINK_Compact_encodeDecimal (int64_t mantissa, int8_t exponent, blink_stream_t out)
 Encode decimal More...
 
uint8_t BLINK_Compact_sizeofUnsigned (uint64_t value)
 Calculate encoded size of unsigned integer. More...
 
uint8_t BLINK_Compact_sizeofSigned (int64_t value)
 Calculate encoded size of signed integer. More...
 

Typedefs

typedef struct blink_stream * blink_stream_t
 

Function Documentation

bool BLINK_Compact_decodeBool ( blink_stream_t  in,
bool *  out,
bool *  isNull 
)

Decode bool

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeDecimal ( blink_stream_t  in,
int64_t *  mantissa,
int8_t *  exponent,
bool *  isNull 
)

Decode decimal

Parameters
[in]ininput stream
[out]mantissadecoded mantissa
[out]exponentdecoded exponent
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeF64 ( blink_stream_t  in,
double *  out,
bool *  isNull 
)

Decode f64

Parameters
[in]ininput stream
[out]outvalue
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeI16 ( blink_stream_t  in,
int16_t *  out,
bool *  isNull 
)

Decode i16

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeI32 ( blink_stream_t  in,
int32_t *  out,
bool *  isNull 
)

Decode i32

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeI64 ( blink_stream_t  in,
int64_t *  out,
bool *  isNull 
)

Decode i64

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeI8 ( blink_stream_t  in,
int8_t *  out,
bool *  isNull 
)

Decode i8

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodePresent ( blink_stream_t  in,
bool *  out 
)

Decode a present field.

Parameters
[in]ininput stream
[out]outset to true if present
Returns
value was decoded
Return values
true
false
bool BLINK_Compact_decodeU16 ( blink_stream_t  in,
uint16_t *  out,
bool *  isNull 
)

Decode u16

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeU32 ( blink_stream_t  in,
uint32_t *  out,
bool *  isNull 
)

Decode u32

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeU64 ( blink_stream_t  in,
uint64_t *  out,
bool *  isNull 
)

Decode u64

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_decodeU8 ( blink_stream_t  in,
uint8_t *  out,
bool *  isNull 
)

Decode u8

Parameters
[in]ininput stream
[out]outdecoded value
[out]isNullset to true if in decodes to NULL
Returns
value was decoded
Return values
true
false
Examples:
tc_blink_compact_decode.c.
bool BLINK_Compact_encodeBool ( bool  in,
blink_stream_t  out 
)

Encode bool

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeDecimal ( int64_t  mantissa,
int8_t  exponent,
blink_stream_t  out 
)

Encode decimal

Parameters
[in]mantissa
[in]exponent
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeF64 ( double  in,
blink_stream_t  out 
)

Encode f64

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeI16 ( int16_t  in,
blink_stream_t  out 
)

Encode i16

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeI32 ( int32_t  in,
blink_stream_t  out 
)

Encode i32

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeI64 ( int64_t  in,
blink_stream_t  out 
)

Encode i64

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeI8 ( int8_t  in,
blink_stream_t  out 
)

Encode i8

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeNull ( blink_stream_t  out)

Encode a null.

Parameters
[in]outoutput stream
Returns
null was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodePresent ( blink_stream_t  out)

Encode a present symbol.

Parameters
[in]outoutput stream
Returns
present was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeU16 ( uint16_t  in,
blink_stream_t  out 
)

Encode u16

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeU32 ( uint32_t  in,
blink_stream_t  out 
)

Encode u32

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeU64 ( uint64_t  in,
blink_stream_t  out 
)

Encode u64

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
bool BLINK_Compact_encodeU8 ( uint8_t  in,
blink_stream_t  out 
)

Encode u8

Parameters
[in]ininput value
[in]outoutput stream
Returns
value was encoded
Return values
true
false
Examples:
tc_blink_compact_encode.c.
uint8_t BLINK_Compact_sizeofSigned ( int64_t  value)

Calculate encoded size of signed integer.

Parameters
[in]valuesigned integer
Returns
encoded size in bytes
uint8_t BLINK_Compact_sizeofUnsigned ( uint64_t  value)

Calculate encoded size of unsigned integer.

Parameters
[in]valueunsigned integer
Returns
encoded size in bytes