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

Structure used to hold state data for a single payload. More...

#include <payload.h>

Data Fields

CdiPayloadType payload_type
 Payload type (application or keep alive).
 
uint16_t maximum_packet_byte_size
 Maximum size of packets in bytes.
 
uint8_t maximum_tx_sgl_entries
 Maximum number of SGL entries for a packet.
 
uint16_t payload_num
 
uint16_t packet_sequence_num
 Current CDI packet sequence number.
 
uint32_t packet_id
 Current CDI packet ID.
 
uint16_t packet_payload_data_size
 Size in bytes of payload data in current CDI packet.
 
const CdiSglEntrysource_entry_ptr
 Current source payload SGL entry being used.
 
int source_entry_address_offset
 
uint32_t payload_data_offset
 Current offset of payload data.
 

Detailed Description

Structure used to hold state data for a single payload.

Field Documentation

◆ payload_num

uint16_t CdiPayloadPacketState::payload_num

Payload number. Value is unique for each Tx connection and increments by 1 for each payload transmitted.

◆ source_entry_address_offset

int CdiPayloadPacketState::source_entry_address_offset

Current source entry address offset of entry being used. Only used if the data size of the source SGL entry is larger than the CDI packet data size (the SGL entry spans more than 1 CDI packet).


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