summaryrefslogblamecommitdiffstats
path: root/posix_users/thread_cancellation.rst
blob: 5a70c4008e14559251e49605806c339f5fac8a7c (plain) (tree)



































                                                               

                                                                  






































































































































                                                             
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.