odp_ml_compl_pool_param_t Struct Reference

ML completion event pool parameters. More...

#include <ml_types.h>

Data Fields
uint32_t	num
	Number of ML completion events in the pool. More...
uint32_t	uarea_size
	User area size in bytes. More...
struct {
void(*   init_fn )(void *uarea, uint32_t size,       void *args, uint32_t index)
	See uarea_init.init_fn of odp_pool_param_t for details (odp_pool_param_t.init_fn). More...
void *   args
	See uarea_init.args of odp_pool_param_t for details (odp_pool_param_t.args). More...
}	uarea_init
	Parameters for user area initialization.
uint32_t	cache_size
	Maximum number of events cached locally per thread. More...

Detailed Description

ML completion event pool parameters.

Use odp_ml_compl_pool_param_init() to initialize the structure to its default values.

Definition at line 141 of file api/spec/ml_types.h.

Field Documentation

num

uint32_t odp_ml_compl_pool_param_t::num

Number of ML completion events in the pool.

The maximum supported value is defined by ML pool capability 'max_num' (odp_ml_compl_pool_capability_t.max_num).

Definition at line 148 of file api/spec/ml_types.h.

uarea_size

uint32_t odp_ml_compl_pool_param_t::uarea_size

User area size in bytes.

The maximum supported value is defined by ML pool capability 'max_uarea_size'. Specify as zero if no user area is needed. The default value is 0.

Definition at line 156 of file api/spec/ml_types.h.

init_fn

void(* odp_ml_compl_pool_param_t::init_fn) (void *uarea, uint32_t size, void *args, uint32_t index)

See uarea_init.init_fn of odp_pool_param_t for details (odp_pool_param_t.init_fn).

Function is called during odp_ml_compl_pool_create(). The default value is NULL.

Definition at line 163 of file api/spec/ml_types.h.

args

void* odp_ml_compl_pool_param_t::args

See uarea_init.args of odp_pool_param_t for details (odp_pool_param_t.args).

The default value is NULL.

Definition at line 167 of file api/spec/ml_types.h.

cache_size

uint32_t odp_ml_compl_pool_param_t::cache_size

Maximum number of events cached locally per thread.

See odp_pool_param_t.cache_size documentation for details. Valid values range from 'min_cache_size' to 'max_cache_size' ML pool capability. The default value is implementation specific and set by odp_ml_compl_pool_param_init().

Definition at line 178 of file api/spec/ml_types.h.

---

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

• api/spec/ml_types.h