TABLE OF CONTENTS

1. Component Library: Thread/cl_pfn_thread_callback_t
2. Component Library: Thread/cl_proc_count
3. Component Library: Thread/cl_thread_stall
4. Component Library: Thread/cl_thread_suspend

Component Library: Thread/cl_pfn_thread_callback_t

    cl_pfn_thread_callback_t

    The cl_pfn_thread_callback_t function type defines the prototype
    for functions invoked by thread objects

typedef void
(*cl_pfn_thread_callback_t)(
    IN  void*   context );

    context
        [in] Value specified in a call to cl_thread_init or
        cl_thread_pool_create.

    This function does not return a value.

    This function type is provided as function prototype reference for
    the function provided by users as a parameter to the cl_thread_init
    and cl_thread_pool_create functions.

    Thread Pool

Component Library: Thread/cl_proc_count

    cl_proc_count

    The cl_proc_count function returns the number of processors in the system.

uint32_t
cl_proc_count( void );

    Returns the number of processors in the system.

Component Library: Thread/cl_thread_stall

    cl_thread_stall

    The cl_thread_stall function stalls the calling thread for a minimum of
    the specified number of microseconds.

void
cl_thread_stall(
    IN  const uint32_t  pause_us );

    pause_us
        [in] Number of microseconds to stall the calling thread.

    This function does not return a value.

    The cl_thread_stall function performs a busy wait for the specified
    number of microseconds. Care should be taken when using this function as
    it does not relinquish its quantum of operation. For longer wait
    operations, users should call cl_thread_suspend if possible.

    Thread, cl_thread_suspend

Component Library: Thread/cl_thread_suspend

    cl_thread_suspend

    The cl_thread_suspend function suspends the calling thread for a minimum
    of the specified number of milliseconds.

void
cl_thread_suspend(
    IN  const uint32_t  pause_ms );

    pause_ms
        [in] Number of milliseconds to suspend the calling thread.

    This function does not return a value.

    This function should only be called if it is valid for the caller's thread
    to enter a wait state. For stalling a thread that cannot enter a wait
    state, callers should use cl_thread_stall.

    Thread, cl_thread_stall