Packet input vector configuration. More...

#include <packet_io_types.h>

Collaboration diagram for odp_pktin_vector_config_t:

Data Fields
odp_bool_t	enable
	Enable packet input vector. More...

odp_pool_t	pool
	Vector pool. More...

uint64_t	max_tmo_ns
	Maximum time to wait for packets. More...

uint32_t	max_size
	Maximum number of packets in a vector. More...

Detailed Description

Packet input vector configuration.

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

Field Documentation

◆ enable

odp_bool_t odp_pktin_vector_config_t::enable

Enable packet input vector.

When true, packet input vector is enabled and configured with vector config parameters. Otherwise, packet input vector configuration parameters are ignored. When vectors are enabled, packets may be delivered both as packet vector events and packet events. The default value is false.

Examples: odp_ipsec.c, and odp_l2fwd.c.

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

◆ pool

odp_pool_t odp_pktin_vector_config_t::pool

Vector pool.

Vector pool to allocate the vectors to hold packets. The pool must have been created with the ODP_POOL_VECTOR type.

Examples: odp_ipsec.c, and odp_l2fwd.c.

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

◆ max_tmo_ns

uint64_t odp_pktin_vector_config_t::max_tmo_ns

Maximum time to wait for packets.

Maximum timeout in nanoseconds to wait for the producer to form the vector of packet events (odp_packet_vector_t). This value should be in the range of odp_pktin_vector_capability_t::min_tmo_ns to odp_pktin_vector_capability_t::max_tmo_ns.

Examples: odp_ipsec.c, and odp_l2fwd.c.

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

◆ max_size

uint32_t odp_pktin_vector_config_t::max_size

Maximum number of packets in a vector.

The packet input subsystem forms packet vector events when either it reaches odp_pktin_vector_config_t::max_tmo_ns or producer reaches max_size packets. This value should be in the range of odp_pktin_vector_capability_t::min_size to odp_pktin_vector_capability_t::max_size.

Note: The maximum number of packets this vector can hold is defined by odp_pool_param_t::vector::max_size with odp_pktin_vector_config_t::pool. The max_size should not be greater than odp_pool_param_t::vector::max_size.

Examples: odp_ipsec.c, and odp_l2fwd.c.

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

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