diff options
Diffstat (limited to 'cpukit/posix/include/rtems/posix/cancel.h')
-rw-r--r-- | cpukit/posix/include/rtems/posix/cancel.h | 30 |
1 files changed, 19 insertions, 11 deletions
diff --git a/cpukit/posix/include/rtems/posix/cancel.h b/cpukit/posix/include/rtems/posix/cancel.h index 228c60c7c4..04f13cea11 100644 --- a/cpukit/posix/include/rtems/posix/cancel.h +++ b/cpukit/posix/include/rtems/posix/cancel.h @@ -1,5 +1,8 @@ /** * @file rtems/posix/cancel.h + * + * This file contains the prototypes and data types used to implement + * POSIX thread cancelation. */ /* @@ -18,36 +21,41 @@ #include <rtems/posix/threadsup.h> +/** + * This structure is used to manage the cancelation handlers. + */ typedef struct { + /** This field is the Chain Node so we can put these on lists. */ Chain_Node Node; + /** This field is the cancelation routine. */ void (*routine)( void * ); + /** This field is the argument to the cancelation routine. */ void *arg; } POSIX_Cancel_Handler_control; -/* - * _POSIX_Threads_cancel_run - * - * DESCRIPTION: +/** + * @brief _POSIX_Threads_cancel_run * * This support routine runs through the chain of cancel handlers that * have been registered and executes them. + * + * @param[in] the_thread is the thread whose cancelation handlers + * should be run */ - void _POSIX_Threads_cancel_run( Thread_Control *the_thread ); -/* - * _POSIX_Thread_Evaluate_cancellation_and_enable_dispatch +/** + * @brief _POSIX_Thread_Evaluate_cancellation_and_enable_dispatch * - * DESCRIPTION: - * * This routine separates a piece of code that existed as part of * another routine, but had to be separated to improve coverage. + * + * @param[in] the_thread is the thread to evaluate canceling */ - void _POSIX_Thread_Evaluate_cancellation_and_enable_dispatch ( - POSIX_API_Control *thread_support + Thread_Control *the_thread ); #endif |