API Reference Manual  1.45.0
odp_packet_tx_compl_opt_t Struct Reference

Packet transmit completion request options. More...

#include <packet_types.h>

Collaboration diagram for odp_packet_tx_compl_opt_t:
[legend]

Data Fields

odp_packet_tx_compl_mode_t mode
 Packet transmit completion mode. More...
 
union {
   odp_queue_t   queue
 Destination queue. More...
 
   uint32_t   compl_id
 Completion identifier. More...
 
}; 
 Union of packet transmit completion destinations.
 

Detailed Description

Packet transmit completion request options.

Examples
odp_l2fwd.c.

Definition at line 451 of file api/spec/packet_types.h.

Field Documentation

◆ mode

odp_packet_tx_compl_mode_t odp_packet_tx_compl_opt_t::mode

Packet transmit completion mode.

When completion mode is ODP_PACKET_TX_COMPL_DISABLED, all other fields of this struct are ignored.

Definition at line 458 of file api/spec/packet_types.h.

◆ queue

odp_queue_t odp_packet_tx_compl_opt_t::queue

Destination queue.

When completion mode is ODP_PACKET_TX_COMPL_EVENT, a packet transmit completion event will be sent to this queue.

Definition at line 468 of file api/spec/packet_types.h.

◆ compl_id

uint32_t odp_packet_tx_compl_opt_t::compl_id

Completion identifier.

When completion mode is ODP_PACKET_TX_COMPL_POLL, a packet transmit completion status will be reported through this completion identifier. Application selects a value between 0 and tx_compl.max_compl_id in packet IO configuration options (see odp_pktio_config_t). Only single packet may be transmitted with the same identifier value at a time (through the same packet IO interface). A value may be reused for the next transmit only after transmit of the previous packet is complete. Multiple packets may have the same identifier value set as long as those packets are not transmitted simultaneously.

Definition at line 482 of file api/spec/packet_types.h.


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