Event vector configuration. More...

#include <event_vector_types.h>

Collaboration diagram for odp_event_aggr_config_t:

Data Fields
odp_pool_t	pool
	Event vector pool. More...

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

uint32_t	max_size
	Maximum number of events in vector. More...

odp_event_type_t	event_type
	Event type. More...

Detailed Description

Event vector configuration.

Definition at line 39 of file api/spec/event_vector_types.h.

Field Documentation

◆ pool

odp_pool_t odp_event_aggr_config_t::pool

Event vector pool.

Pool from which to allocate event vectors. The pool must have been created with the ODP_POOL_EVENT_VECTOR type.

Definition at line 45 of file api/spec/event_vector_types.h.

◆ max_tmo_ns

uint64_t odp_event_aggr_config_t::max_tmo_ns

Maximum time to wait for events.

Maximum time in nanoseconds for an event aggregator to form an event vector. This value should be in the range of odp_event_aggr_capability_t::min_tmo_ns to odp_event_aggr_capability_t::max_tmo_ns.

Value of zero means there is no timeout. Events may wait aggregation indefinitely in the aggregation queue.

Definition at line 57 of file api/spec/event_vector_types.h.

◆ max_size

uint32_t odp_event_aggr_config_t::max_size

Maximum number of events in vector.

Event aggregator forms an event vector event after 'max_size' events have been collected or 'max_tmo_ns' has passed. 'max_size' value should be in the range of odp_event_aggr_capability_t::min_size to odp_event_aggr_capability_t::max_size.

The maximum number of events an event vector can hold is defined by odp_pool_param_t::event_vector.max_size of the event vector pool. 'max_size' must not be greater than that value.

Definition at line 70 of file api/spec/event_vector_types.h.

◆ event_type

odp_event_type_t odp_event_aggr_config_t::event_type

Event type.

Event type of event aggregator. If 'event_type' is ODP_EVENT_ANY, application is allowed to enqueue any event types, except event vectors, to the event aggregator. Otherwise, only events of type 'event_type' are allowed. The default value is ODP_EVENT_ANY.

Regardless of 'event_type', an application is never allowed to enqueue event vector or packet vector events (ODP_EVENT_VECTOR or ODP_EVENT_PACKET_VECTOR) to an event aggregator queue (i.e. vectors within vectors).

Definition at line 84 of file api/spec/event_vector_types.h.

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