|
CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
|
Structure definition behind the connection handles shared with the user's application program. Its contents are opaque to the user's program where it only has a pointer to a declared but not defined structure. More...
#include <private.h>
Data Fields | ||
| CdiListEntry | list_entry | |
| Used to store an instance of this object in a list using this element as the list item. | ||
| uint32_t | magic | |
| Set to kMagicConnection when allocated, checked at every API function to help ensure validity. | ||
| CdiSignalType | start_signal | |
| CdiSignalType | shutdown_signal | |
| Signal used to shutdown connection threads. | ||
| EndpointManagerHandle | endpoint_manager_handle | |
| Handle of Endpoint Manager for this connection. Manages the list of endpoints associated with this connection. | ||
| CdiEndpointState * | default_tx_endpoint_ptr | |
| The instance of the default Tx endpoint object underlying this connection. | ||
| CdiAdapterState * | adapter_state_ptr | |
| The instance of the adapter this Tx/Rx object is associated with. | ||
| AdapterConnectionState * | adapter_connection_ptr | |
| The instance of the adapter connection object underlying this connection. | ||
| CdiThreadID | app_payload_message_thread_id | |
| The ID of the thread that services payload messages from the related adapter. | ||
| CdiQueueHandle | app_payload_message_queue_handle | |
| Queue of payload AppPayloadCallbackData structures. | ||
| CdiPoolHandle | linear_buffer_pool | |
| Pool of linear buffers in which to store incoming payloads if the connection was created with kCdiLinearBuffer. | ||
| ConnectionHandleType | handle_type | |
| Indicates which structure of the union is valid. | ||
| union { | ||
| TxConState tx_state | ||
| The internal state of the structure if ConnectionHandleType is kHandleTypeTx. | ||
| RxConState rx_state | ||
| The internal state of the structure if ConnectionHandleType is kHandleTypeRx. | ||
| }; | ||
| StatisticsState * | stats_state_ptr | |
| Pointer to statistics state data. | ||
| CdiStatsCallbackHandle | stats_cb_handle | |
| Handle of currently user-registered statistics callback. | ||
| CdiConnectionProtocolType | protocol_type | |
| Connection protocol type. | ||
| CdiThreadID | payload_thread_id | |
| Data for payload worker thread. Either used for TxPayloadThread(). | ||
| char | saved_connection_name_str [CDI_MAX_CONNECTION_NAME_STRING_LENGTH] | |
| Name of the connection. | ||
| CdiLogHandle | log_handle | |
| Logger handle used for this connection. If NULL, the global logger is used. | ||
| CdiPoolHandle | error_message_pool | |
| Pool used to hold error message strings. | ||
| CdiBackPressureState | back_pressure_state | |
| Back pressure state. | ||
Structure definition behind the connection handles shared with the user's application program. Its contents are opaque to the user's program where it only has a pointer to a declared but not defined structure.
| CdiThreadID CdiConnectionState::payload_thread_id |
Data for payload worker thread. Either used for TxPayloadThread().
Payload thread identifier
| CdiSignalType CdiConnectionState::start_signal |
Signal used to start connection threads. A separate signal is used for the adapter endpoints (see AdapterEndpointState.start_signal).