CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
AppPayloadCallbackData Struct Reference

This defines a structure that contains all of the data required to use the application registered payload callback functions. More...

#include <private.h>

Data Fields

CdiListEntry list_entry
 Allows this structure to be used as part of a list.
 
CdiReturnStatus payload_status_code
 Status of the payload.
 
CdiCoreExtraData core_extra_data
 Core extra data.
 
uint16_t extra_data_size
 Size of extra data.
 
uint8_t extra_data_array [MAX_CDI_PACKET_EXTRA_DATA]
 Extra data sent along in the CDI header packet.
 
CdiSgList payload_sgl
 Scatter-Gather List for the payload.
 
CdiUserCbParameter tx_payload_user_cb_param
 For Tx connection, the payload user callback parameter that was provided in CdiCoreTxPayloadConfig.
 
CdiSgList tx_source_sgl
 For Tx connection, Tx payload source SGL that needs to be freed.
 
char * error_message_str
 Pointer to error message string. It uses a pool, so must be freed after the user-registered callback function has been invoked.
 
uint64_t tx_start_time_microseconds
 Payload Tx start time in microseconds since epoch. NOTE: Only valid for protocols 2 and later.
 
uint64_t receive_buffer_send_time
 The time in microsends according to the value returned by CdiOsGetMicroseconds() at which this payload should be sent to the application callback thread. This member is only used if the receive buffer is enabled.
 

Detailed Description

This defines a structure that contains all of the data required to use the application registered payload callback functions.


The documentation for this struct was generated from the following file: