Rate This Document
Findability
Accuracy
Completeness
Readability

HTL_thread_scheduler_get_migr_pool_fn

Prototype of the function for obtaining a migration pool.

Prototype

typedef HTL_thread_pool_t (*HTL_thread_scheduler_get_migr_pool_fn)(HTL_thread_scheduler_t);

Description

Function for obtaining a migration pool, get_migr_pool(), that returns the thread pool associated with the scheduler. This pool is used as the migration pool.

If get_migr_pool() returns HTL_THREAD_POOL_NULL or a scheduler-irrelevant pool, an undefined result occurs.

get_migr_pool() is optional and can be set to NULL. If so, HTL selects a proper pool associated with the scheduler.

Parameters

Type

Description

Input/Output

HTL_thread_scheduler_t

Handle to the scheduler.

Input

Return Value

HTL_thread_pool_t: handle to the thread pool.