source: rtems/cpukit/posix/include/rtems/posix/cancel.h @ cf301c9

4.11
Last change on this file since cf301c9 was cf301c9, checked in by Alex Ivanov <alexivanov97@…>, on Jan 7, 2013 at 2:53:43 PM

posix: Doxygen Clean Up Task #1

  • Property mode set to 100644
File size: 1.6 KB
Line 
1/**
2 * @file
3 *
4 * @brief POSIX Thread Cancelation Support
5 *
6 * This file contains the prototypes and data types used to implement
7 * POSIX thread cancelation.
8 */
9
10/*
11 *  COPYRIGHT (c) 1989-2009.
12 *  On-Line Applications Research Corporation (OAR).
13 *
14 *  The license and distribution terms for this file may be
15 *  found in the file LICENSE in this distribution or at
16 *  http://www.rtems.com/license/LICENSE.
17 */
18
19#ifndef _RTEMS_POSIX_CANCEL_H
20#define _RTEMS_POSIX_CANCEL_H
21
22#include <rtems/posix/threadsup.h>
23
24/**
25 * This structure is used to manage the cancelation handlers.
26 */
27typedef struct {
28  /** This field is the Chain Node so we can put these on lists. */
29  Chain_Node  Node;
30  /** This field is the cancelation routine. */
31  void      (*routine)( void * );
32  /** This field is the argument to the cancelation routine. */
33  void       *arg;
34}  POSIX_Cancel_Handler_control;
35
36/**
37 * @brief POSIX run thread cancelation.
38 *
39 * This support routine runs through the chain of cancel handlers that
40 * have been registered and executes them.
41 *
42 * @param[in] the_thread is a pointer to the thread whose cancelation handlers
43 *            should be run
44 */
45void _POSIX_Threads_cancel_run(
46  Thread_Control *the_thread
47);
48
49/**
50 * @brief POSIX evaluate thread cancelation and enable dispatch.
51 *
52 * This routine separates a piece of code that existed as part of
53 * another routine, but had to be separated to improve coverage.
54 *
55 * @param[in] the_thread is a pointer to the thread to evaluate canceling
56 */
57void _POSIX_Thread_Evaluate_cancellation_and_enable_dispatch (
58  Thread_Control *the_thread
59);
60
61#endif
62/* end of include file */
Note: See TracBrowser for help on using the repository browser.