From 72a62ad88f82fe1ffee50024db4dd0f3fa5806f7 Mon Sep 17 00:00:00 2001 From: Chris Johns Date: Thu, 3 Nov 2016 16:58:08 +1100 Subject: Rename all manuals with an _ to have a -. It helps released naming of files. --- posix-users/thread_cancellation.rst | 201 ++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 posix-users/thread_cancellation.rst (limited to 'posix-users/thread_cancellation.rst') diff --git a/posix-users/thread_cancellation.rst b/posix-users/thread_cancellation.rst new file mode 100644 index 0000000..ae14542 --- /dev/null +++ b/posix-users/thread_cancellation.rst @@ -0,0 +1,201 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: COPYRIGHT (c) 1988-2002. +.. COMMENT: On-Line Applications Research Corporation (OAR). +.. COMMENT: All rights reserved. + +Thread Cancellation Manager +########################### + +Introduction +============ + +The +thread cancellation manager is ... + +The directives provided by the thread cancellation manager are: + +- pthread_cancel_ - Cancel Execution of a Thread + +- pthread_setcancelstate_ - Set Cancelability State + +- pthread_setcanceltype_ - Set Cancelability Type + +- pthread_testcancel_ - Create Cancellation Point + +- pthread_cleanup_push_ - Establish Cancellation Handler + +- pthread_cleanup_pop_ - Remove Cancellation Handler + +Background +========== + +There is currently no text in this section. + +Operations +========== + +There is currently no text in this section. + +Directives +========== + +This section details the thread cancellation manager's directives. A +subsection is dedicated to each of this manager's directives and describes the +calling sequence, related constants, usage, and status codes. + +.. _pthread_cancel: + +pthread_cancel - Cancel Execution of a Thread +--------------------------------------------- +.. index:: pthread_cancel +.. index:: cancel execution of a thread + +**CALLING SEQUENCE:** + +.. code-block:: c + + int pthread_cancel( + ); + +**STATUS CODES:** + +.. list-table:: + :class: rtems-table + + * - ``E`` + - The + +**DESCRIPTION:** + +**NOTES:** + +.. _pthread_setcancelstate: + +pthread_setcancelstate - Set Cancelability State +------------------------------------------------ +.. index:: pthread_setcancelstate +.. index:: set cancelability state + +**CALLING SEQUENCE:** + +.. code-block:: c + + int pthread_setcancelstate( + ); + +**STATUS CODES:** + +.. list-table:: + :class: rtems-table + + * - ``E`` + - The + +**DESCRIPTION:** + +**NOTES:** + +.. _pthread_setcanceltype: + +pthread_setcanceltype - Set Cancelability Type +---------------------------------------------- +.. index:: pthread_setcanceltype +.. index:: set cancelability type + +**CALLING SEQUENCE:** + +.. code-block:: c + + int pthread_setcanceltype( + ); + +**STATUS CODES:** + +.. list-table:: + :class: rtems-table + + * - ``E`` + - The + +**DESCRIPTION:** + +**NOTES:** + +.. _pthread_testcancel: + +pthread_testcancel - Create Cancellation Point +---------------------------------------------- +.. index:: pthread_testcancel +.. index:: create cancellation point + +**CALLING SEQUENCE:** + +.. code-block:: c + + int pthread_testcancel( + ); + +**STATUS CODES:** + +.. list-table:: + :class: rtems-table + + * - ``E`` + - The + +**DESCRIPTION:** + +**NOTES:** + +.. _pthread_cleanup_push: + +pthread_cleanup_push - Establish Cancellation Handler +----------------------------------------------------- +.. index:: pthread_cleanup_push +.. index:: establish cancellation handler + +**CALLING SEQUENCE:** + +.. code-block:: c + + int pthread_cleanup_push( + ); + +**STATUS CODES:** + +.. list-table:: + :class: rtems-table + + * - ``E`` + - The + +**DESCRIPTION:** + +**NOTES:** + +.. _pthread_cleanup_pop: + +pthread_cleanup_pop - Remove Cancellation Handler +------------------------------------------------- +.. index:: pthread_cleanup_pop +.. index:: remove cancellation handler + +**CALLING SEQUENCE:** + +.. code-block:: c + + int pthread_cleanup_push( + ); + +**STATUS CODES:** + +.. list-table:: + :class: rtems-table + + * - ``E`` + - The + +**DESCRIPTION:** + +**NOTES:** -- cgit v1.2.3