pthread_cancel(3) [osx man page]

PTHREAD_CANCEL(3)					   BSD Library Functions Manual 					 PTHREAD_CANCEL(3)

NAME

     pthread_cancel -- cancel execution of a thread

SYNOPSIS

     #include <pthread.h>

     int
     pthread_cancel(pthread_t thread);

DESCRIPTION

     The pthread_cancel() function requests that thread be canceled.  The target thread's cancelability state and type determines when the cancel-
     lation takes effect.  When the cancellation is acted on, the cancellation cleanup handlers for thread are called.	When the last cancellation
     cleanup handler returns, the thread-specific data destructor functions will be called for thread.	When the last destructor function returns,
     thread will be terminated.

     The cancellation processing in the target thread runs asynchronously with respect to the calling thread returning from pthread_cancel().

     A status of PTHREAD_CANCELED is made available to any threads joining with the target.  The symbolic constant PTHREAD_CANCELED expands to a
     constant expression of type (void *), whose value matches no pointer to an object in memory nor the value NULL.

RETURN VALUES

     If successful,  the pthread_cancel() functions will return zero.  Otherwise an error number will be returned to indicate the error.

ERRORS

     pthread_cancel() will fail if:

     [ESRCH]		No thread could be found corresponding to that specified by the given thread ID.

SEE ALSO

     pthread_cleanup_pop(3), pthread_cleanup_push(3), pthread_exit(3), pthread_join(3), pthread_setcancelstate(3), pthread_setcanceltype(3),
     pthread_testcancel(3)

STANDARDS

     pthread_cancel() conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').

AUTHORS

     This man page was written by David Leonard <d@openbsd.org> for the OpenBSD implementation of pthread_cancel().

BSD
								 January 17, 1999							       BSD

pthread_cancel(3T)														pthread_cancel(3T)

NAME

       pthread_cancel() - cancel execution of a thread

SYNOPSIS


PARAMETERS

	      thread	Target thread to be canceled.

DESCRIPTION

       requests that thread (hereby referred to as target thread) be canceled.	It allows a thread to terminate the execution of any thread in the
       process in a controlled manner.

       The target thread's cancelability state and type determine when the cancellation takes effect.  Cancellation only occurs  when  the  target
       thread's  cancelability	state  is When the target thread's cancelability state is cancellation requests against the target thread are held
       pending and will be acted upon when cancellation is enabled.

       When the cancelability type is for the target thread, new or pending cancellation requests are acted upon at any  time.	 When  the  target
       thread's cancelability type is cancellation requests are held pending until the target thread reaches a cancellation point (see below).

       If  the target thread's cancelability state is disabled, the cancelability type does not matter.  When cancelability is enabled, the cance-
       lability type will take effect.

       When the cancellation is acted on, the cancellation cleanup handlers for thread are called.  The cancellation cleanup handlers  are  called
       in  the opposite order in which they were installed.  When the last cancellation cleanup handler returns, the thread-specific data destruc-
       tor functions for thread are called.  When the last destructor function returns, thread shall be terminated.

       The caller of will not wait for the target thread to be canceled.

   Cancellation Points
       are points inside of certain functions where a thread must act on any pending cancellation request when cancelability  is  enabled  if  the
       function would block.

RETURN VALUE

       Upon successful completion, returns zero.  Otherwise, an error number is returned to indicate the error (the variable is not set).

ERRORS

       For each of the following conditions, if the condition is detected, the function returns the corresponding error number:

	      [ESRCH]	     No thread could be found corresponding to thread.

WARNINGS

       Use  of	asynchronous  cancelability while holding resources that need to be released may result in resource loss.  Applications must care-
       fully follow static lexical scoping rules in their execution behavior.  For instance, the use of return, goto, etc., to leave  user-defined
       cancellation scopes without doing the necessary scope pop will result in undefined behavior.

AUTHOR

       was derived from the IEEE POSIX P1003.1c standard.

SEE ALSO

       pthread_exit(3T), pthread_join(3T), pthread_setcancelstate(3T), pthread_cleanup_pop(3T), pthread_cond_wait(3T).

STANDARDS CONFORMANCE

								  Pthread Library						pthread_cancel(3T)