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

Structure used to hold a transmit packet work request. The lifespan of a work request starts when a packet is queued to be sent and ends when a message is received that it has either been successfully sent or a failure has occurred. More...

#include <internal_tx.h>

Data Fields

TxPayloadStatepayload_state_ptr
 Pointer to Tx payload state structure.
 
uint16_t payload_num
 Packet payload number.
 
uint16_t packet_payload_size
 Size of payload, not including the packet header.
 
Packet packet
 The top level packet structure for the data in this work request.
 
CdiPoolHandle header_pool_handle
 Handle of pool associated with header pointer in structure below. If non-null then header pointer is valid. If payload_state_ptr->app_payload_cb_data.extra_data_size is non-zero, then extra_header_ptr is used, otherwise header_ptr is used.
 
union { 
 
   void *   union_ptr 
 
   TxPacketHeader *   header_ptr 
 Pointer to data for the packet header. It uses entry zero in the packet SGL. NOTE: Must point to a buffer in the DMA TX memory region that is allocated during adapter initialization.
 
   TxExtraPacketHeader *   extra_header_ptr 
 Pointer to data for the packet header that contains extra data. It uses entry zero in the packet SGL. NOTE: Must point to a buffer in the DMA TX memory region that is allocated during adapter initialization.
 
};  
 

Detailed Description

Structure used to hold a transmit packet work request. The lifespan of a work request starts when a packet is queued to be sent and ends when a message is received that it has either been successfully sent or a failure has occurred.

Field Documentation

◆ union_ptr

void* TxPacketWorkRequest::union_ptr

Generic pointer used as pool item parameter when using the Pool API.


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