|
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 the parameter to CdiCoreConnectionCallback(). It contains data related to the status of a single connection. More...
#include <cdi_core_api.h>
Data Fields | |
| CdiConnectionStatus | status_code |
| Current status of the connection. | |
| const char * | err_msg_str |
| If the connection is not connected, 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. | |
| CdiEndpointHandle | tx_stream_endpoint_handle |
| Used to identify the handle of the stream endpoint associated with the connection. Only valid for Tx endpoints that were created using the CdiAvmTxStreamEndpointCreate() function. Value is NULL for Rx endpoints. | |
| const char * | remote_ip_str |
| Pointer to remote IP address string. | |
| int | remote_dest_port |
| Remote destination port. | |
| CdiUserCbParameter | connection_user_cb_param |
| User defined connection callback parameter. For a transmitter, this value is set as part of the CdiTxConfigData data provided as a parameter to one of the Cdi...TxCreate() API functions. For a receiver, this value is set as part of the CdiRxConfigData data provided to one of the Cdi...RxCreate() API functions. | |
| uint8_t | negotiated_version_num |
| Negotiated CDI protocol version number for the endpoint associated with this connection. | |
| uint8_t | negotiated_major_version_num |
| Negotiated CDI protocol major version number. | |
| uint8_t | negotiated_probe_version_num |
| Negotiated CDI protocol probe version number. | |
A structure of this type is passed as the parameter to CdiCoreConnectionCallback(). It contains data related to the status of a single connection.