Generated from ./inc/complib/cl_thread.h with ROBODoc v4.99.17 on Sun Mar 04 2007 18:17:51

[Functions] Component Library: Thread/cl_is_blockable

[top][index]

NAME

       cl_is_blockable

DESCRIPTION

       The cl_is_blockable indicates if the current caller context is
       blockable.

SYNOPSIS

CL_EXPORT boolean_t CL_API
cl_is_blockable( void );

RETURN VALUE

       TRUE if the caller's thread context can be blocked, i.e it is safe
       to perform a sleep, or call a down operation on a semaphore.

       FALSE otherwise

SEE ALSO

       Thread

[Definitions] Component Library: Thread/cl_pfn_thread_callback_t

[top][index]

NAME

       cl_pfn_thread_callback_t

DESCRIPTION

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

SYNOPSIS

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

PARAMETERS

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

RETURN VALUE

       This function does not return a value.

NOTES

       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.

SEE ALSO

       Thread Pool

[Functions] Component Library: Thread/cl_proc_count

[top][index]

NAME

       cl_proc_count

DESCRIPTION

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

SYNOPSIS

CL_EXPORT uint32_t CL_API
cl_proc_count( void );

RETURN VALUE

       Returns the number of processors in the system.

[Functions] Component Library: Thread/cl_thread_stall

[top][index]

NAME

       cl_thread_stall

DESCRIPTION

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

SYNOPSIS

CL_EXPORT void CL_API
cl_thread_stall(
        IN      const uint32_t  pause_us );

PARAMETERS

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

RETURN VALUE

       This function does not return a value.

NOTES

       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.

SEE ALSO

       Thread, cl_thread_suspend

[Functions] Component Library: Thread/cl_thread_suspend

[top][index]

NAME

       cl_thread_suspend

DESCRIPTION

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

SYNOPSIS

CL_EXPORT void CL_API
cl_thread_suspend(
        IN      const uint32_t  pause_ms );

PARAMETERS

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

RETURN VALUE

       This function does not return a value.

NOTES

       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.

SEE ALSO

       Thread, cl_thread_stall