Rate This Document
Findability
Accuracy
Completeness
Readability

HTL_thread_scheduler_free_fn

Prototype of the function for releasing the scheduler.

Prototype

typedef int (*HTL_thread_scheduler_free_fn)(HTL_thread_scheduler_t);

Description

Scheduler release function free() that deinitializes the scheduler. HTL ignores the return value of free().

free() is optional and can be set to NULL.

free() is called only when the scheduler is being released. It is not called when its associated worker stops.

Parameters

Type

Description

Input/Output

HTL_thread_scheduler_t

Handle to the scheduler.

Input

Return Value

  • HTL_THREAD_SUCCESS: success.
  • Other values: failure.