|
CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
|
A structure of this type is passed as part of the data to the TX/RX registered user callback functions. It contains data related to the transmission of a single payload. More...
#include <cdi_core_api.h>
Data Fields | |
| CdiReturnStatus | status_code |
| If payload was successfully sent and received by the receiver, value will be kCdiStatusOk. Otherwise,indicates the general reason for the error condition. Use err_msg_str for a detailed error message string. | |
| const char * | err_msg_str |
| If an error or timeout occurred while transmitting the payload, this will point to a NULL terminated error message string. The memory containing the error string is allocated by the SDK and will be freed upon return from the callback function. The application needs to copy the message to its own memory before returning if it needs it to be retained. | |
| CdiConnectionHandle | connection_handle |
| The handle of the instance which was created using a previous call to one of the Cdi...Create() API functions. | |
| CdiCoreExtraData | core_extra_data |
| Extra data that was sent along with the payload. | |
| CdiUserCbParameter | user_cb_param |
| User defined callback parameter. For a transmitter, this value is set as part of the CdiCoreTxPayloadConfig data provided as a parameter to one of the Cdi...TX..Payload() API functions. For a receiver, this value is set as part of the CdiRxConfigData data provided to one of the Cdi...RxCreate() APIs functions. | |
A structure of this type is passed as part of the data to the TX/RX registered user callback functions. It contains data related to the transmission of a single payload.