TSP: The Transport Sample Protocol



Sample Symbol Information Handling
[TSP Common Library]

Collaboration diagram for Sample Symbol Information Handling:The Sample Symbol Information Handling part of the TSP Common Library regroup a set of functions which should be used to decode the Sample Symbol Information object and list of them. More...

Typedefs

typedef int32_t(*) TSP_data_decoder_t (void *out_buf, uint32_t dimension, char *in_buf)
 Generic function to decode data.

Functions

int32_t TSP_data_channel_char_decoder (void *out_char, uint32_t dimension, char *in_buf)
 function to decode char
int32_t TSP_data_channel_double_decoder (void *out_double, uint32_t dimension, char *in_buf)
 function to decode double
int32_t TSP_data_channel_float_decoder (void *out_float, uint32_t dimension, char *in_buf)
 function to decode float
_EXPORT_TSP_COMMON TSP_data_decoder_t TSP_data_channel_get_decoder (TSP_datatype_t type)
 Get the function that's used to decode a data type encoded in the data stream.
_EXPORT_TSP_COMMON int32_t TSP_data_channel_get_encoded_size (TSP_datatype_t type)
 Get the size of an encoded data type coming from the data stream.
int32_t TSP_data_channel_int16_decoder (void *out_int16, uint32_t dimension, char *in_buf)
 function to decode int16
int32_t TSP_data_channel_int32_decoder (void *out_int32, uint32_t dimension, char *in_buf)
 function to decode int32
int32_t TSP_data_channel_int64_decoder (void *out_int64, uint32_t dimension, char *in_buf)
 function to decode int64
int32_t TSP_data_channel_int8_decoder (void *out_int8, uint32_t dimension, char *in_buf)
 function to decode int8
int32_t TSP_data_channel_uchar_decoder (void *out_uchar, uint32_t dimension, char *in_buf)
 function to decode uchar
int32_t TSP_data_channel_uint16_decoder (void *out_uint16, uint32_t dimension, char *in_buf)
 function to decode uint16
int32_t TSP_data_channel_uint32_decoder (void *out_uint32, uint32_t dimension, char *in_buf)
 function to decode uint32
int32_t TSP_data_channel_uint64_decoder (void *out_uint64, uint32_t dimension, char *in_buf)
 function to decode uint64
int32_t TSP_data_channel_uint8_decoder (void *out_uint8, uint32_t dimension, char *in_buf)
 function to decode uint8
int32_t TSP_data_channel_user_decoder (void *out_user, uint32_t dimension, char *in_buf)
 function to decode user type


Detailed Description

The Sample Symbol Information Handling part of the TSP Common Library regroup a set of functions which should be used to decode the Sample Symbol Information object and list of them.


Typedef Documentation

typedef int32_t(*) TSP_data_decoder_t(void *out_buf, uint32_t dimension, char *in_buf)

Generic function to decode data.

Parameters:
[out] out_buf buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK


Function Documentation

int32_t TSP_data_channel_char_decoder ( void *  out_char,
uint32_t  dimension,
char *  in_buf 
)

function to decode char

Parameters:
[out] out_char buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_double_decoder ( void *  out_double,
uint32_t  dimension,
char *  in_buf 
)

function to decode double

Parameters:
[out] out_double buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_float_decoder ( void *  out_float,
uint32_t  dimension,
char *  in_buf 
)

function to decode float

Parameters:
[out] out_float buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

_EXPORT_TSP_COMMON TSP_data_decoder_t TSP_data_channel_get_decoder ( TSP_datatype_t  type  ) 

Get the function that's used to decode a data type encoded in the data stream.

This function address is stored by the group object to decode the incoming data as fast as possible.

Parameters:
[in] type data type to determine the decoder to use
Returns:
The address of the decoder function for the data type

_EXPORT_TSP_COMMON int32_t TSP_data_channel_get_encoded_size ( TSP_datatype_t  type  ) 

Get the size of an encoded data type coming from the data stream.

Parameters:
[in] type data type to determine the data type size
Returns:
The size of an encoded ddata for the data stream

int32_t TSP_data_channel_int16_decoder ( void *  out_int16,
uint32_t  dimension,
char *  in_buf 
)

function to decode int16

Parameters:
[out] out_int16 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_int32_decoder ( void *  out_int32,
uint32_t  dimension,
char *  in_buf 
)

function to decode int32

Parameters:
[out] out_int32 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_int64_decoder ( void *  out_int64,
uint32_t  dimension,
char *  in_buf 
)

function to decode int64

Parameters:
[out] out_int64 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_int8_decoder ( void *  out_int8,
uint32_t  dimension,
char *  in_buf 
)

function to decode int8

Parameters:
[out] out_int8 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_uchar_decoder ( void *  out_uchar,
uint32_t  dimension,
char *  in_buf 
)

function to decode uchar

Parameters:
[out] out_uchar buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_uint16_decoder ( void *  out_uint16,
uint32_t  dimension,
char *  in_buf 
)

function to decode uint16

Parameters:
[out] out_uint16 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_uint32_decoder ( void *  out_uint32,
uint32_t  dimension,
char *  in_buf 
)

function to decode uint32

Parameters:
[out] out_uint32 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_uint64_decoder ( void *  out_uint64,
uint32_t  dimension,
char *  in_buf 
)

function to decode uint64

Parameters:
[out] out_uint64 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_uint8_decoder ( void *  out_uint8,
uint32_t  dimension,
char *  in_buf 
)

function to decode uint8

Parameters:
[out] out_uint8 buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

int32_t TSP_data_channel_user_decoder ( void *  out_user,
uint32_t  dimension,
char *  in_buf 
)

function to decode user type

Parameters:
[out] out_user buffer where decoded data are stored.
[in] dimension of the data
[in] in_buf data to decode
Returns:
TRUE or FALSE. TRUE = OK

Framework Home Page.


Beware !! TSP wave is coming...