API Reference Manual  1.46.0
Data Fields
odp_pktout_queue_param_t Struct Reference
ODP PACKET IO

Packet output queue parameters. More...

#include <packet_io_types.h>

Data Fields

odp_pktio_op_mode_t op_mode
 Operation mode. More...
 
uint32_t num_queues
 Number of output queues to be created. More...
 
uint32_t queue_size [ODP_PKTOUT_MAX_QUEUES]
 Output queue size array. More...
 

Detailed Description

Packet output queue parameters.

These parameters are used in ODP_PKTOUT_MODE_DIRECT and ODP_PKTOUT_MODE_QUEUE modes.

Examples
odp_bench_pktio_sp.c, odp_classifier.c, odp_dmafwd.c, odp_ipsecfwd.c, odp_l2fwd.c, odp_l2fwd_perf.c, odp_l3fwd.c, odp_packet_gen.c, odp_ping.c, odp_pktio_ordered.c, odp_sched_pktio.c, odp_simple_pipeline.c, and odp_switch.c.

Definition at line 317 of file api/spec/packet_io_types.h.

Field Documentation

◆ op_mode

odp_pktio_op_mode_t odp_pktout_queue_param_t::op_mode

Operation mode.

The default value is ODP_PKTIO_OP_MT. Application may enable performance optimization by defining ODP_PKTIO_OP_MT_UNSAFE when applicable.

Examples
odp_dmafwd.c, odp_ipsecfwd.c, odp_l2fwd.c, odp_l2fwd_perf.c, odp_l3fwd.c, odp_packet_gen.c, odp_pktio_ordered.c, odp_sched_pktio.c, odp_simple_pipeline.c, and odp_switch.c.

Definition at line 323 of file api/spec/packet_io_types.h.

◆ num_queues

uint32_t odp_pktout_queue_param_t::num_queues

Number of output queues to be created.

The value must be between 1 and interface capability. The default value is 1.

Examples
odp_bench_pktio_sp.c, odp_classifier.c, odp_dmafwd.c, odp_ipsecfwd.c, odp_l2fwd.c, odp_l2fwd_perf.c, odp_l3fwd.c, odp_packet_gen.c, odp_ping.c, odp_pktio_ordered.c, odp_sched_pktio.c, and odp_switch.c.

Definition at line 327 of file api/spec/packet_io_types.h.

◆ queue_size

uint32_t odp_pktout_queue_param_t::queue_size[ODP_PKTOUT_MAX_QUEUES]

Output queue size array.

An array containing queue sizes for each 'num_queues' output queues. The value of zero means implementation specific default size. Nonzero values must be between 'min_output_queue_size' and 'max_output_queue_size' capabilities. The implementation may round-up given values. The default value is zero.

Definition at line 337 of file api/spec/packet_io_types.h.

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