summaryrefslogtreecommitdiffstats
path: root/posix_users/thread_cancellation.rst
diff options
context:
space:
mode:
authorAmar Takhar <amar@rtems.org>2016-01-17 00:55:21 -0500
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:23 -0400
commit1264a8f1089fad85cabb024c930b19b0a36864b4 (patch)
treef95424251f62abd513babf47148828ca402dc893 /posix_users/thread_cancellation.rst
parentec76eca9cc967e0d8990316eee1d1841387f5210 (diff)
downloadrtems-docs-1264a8f1089fad85cabb024c930b19b0a36864b4.tar.bz2
Split document into seperate files by section.
Diffstat (limited to 'posix_users/thread_cancellation.rst')
-rw-r--r--posix_users/thread_cancellation.rst173
1 files changed, 173 insertions, 0 deletions
diff --git a/posix_users/thread_cancellation.rst b/posix_users/thread_cancellation.rst
new file mode 100644
index 0000000..5c8aac3
--- /dev/null
+++ b/posix_users/thread_cancellation.rst
@@ -0,0 +1,173 @@
+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 - Cancel Execution of a Thread
+---------------------------------------------
+.. index:: pthread_cancel
+.. index:: cancel execution of a thread
+
+**CALLING SEQUENCE:**
+
+.. code:: c
+
+ int pthread_cancel(
+ );
+
+**STATUS CODES:**
+
+*E*
+ The
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+pthread_setcancelstate - Set Cancelability State
+------------------------------------------------
+.. index:: pthread_setcancelstate
+.. index:: set cancelability state
+
+**CALLING SEQUENCE:**
+
+.. code:: c
+
+ int pthread_setcancelstate(
+ );
+
+**STATUS CODES:**
+
+*E*
+ The
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+pthread_setcanceltype - Set Cancelability Type
+----------------------------------------------
+.. index:: pthread_setcanceltype
+.. index:: set cancelability type
+
+**CALLING SEQUENCE:**
+
+.. code:: c
+
+ int pthread_setcanceltype(
+ );
+
+**STATUS CODES:**
+
+*E*
+ The
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+pthread_testcancel - Create Cancellation Point
+----------------------------------------------
+.. index:: pthread_testcancel
+.. index:: create cancellation point
+
+**CALLING SEQUENCE:**
+
+.. code:: c
+
+ int pthread_testcancel(
+ );
+
+**STATUS CODES:**
+
+*E*
+ The
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+pthread_cleanup_push - Establish Cancellation Handler
+-----------------------------------------------------
+.. index:: pthread_cleanup_push
+.. index:: establish cancellation handler
+
+**CALLING SEQUENCE:**
+
+.. code:: c
+
+ int pthread_cleanup_push(
+ );
+
+**STATUS CODES:**
+
+*E*
+ The
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+pthread_cleanup_pop - Remove Cancellation Handler
+-------------------------------------------------
+.. index:: pthread_cleanup_pop
+.. index:: remove cancellation handler
+
+**CALLING SEQUENCE:**
+
+.. code:: c
+
+ int pthread_cleanup_push(
+ );
+
+**STATUS CODES:**
+
+*E*
+ The
+
+**DESCRIPTION:**
+
+**NOTES:**
+
+.. COMMENT: COPYRIGHT (c) 1988-2002.
+
+.. COMMENT: On-Line Applications Research Corporation (OAR).
+
+.. COMMENT: All rights reserved.
+