pthread_cancel(3) [freebsd man page]

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

NAME

     pthread_cancel -- cancel execution of a thread

LIBRARY

     POSIX Threads Library (libpthread, -lpthread)

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

     The pthread_cancel() function 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

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

AUTHORS

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

BSD
								 January 17, 1999							       BSD

pthread_cancel(3C)					   Standard C Library Functions 					pthread_cancel(3C)

NAME

       pthread_cancel - cancel execution of a thread

SYNOPSIS

       cc -mt [ flag... ] file... -lpthread [ library... ]
       #include <pthread.h>

       int pthread_cancel(pthread_t target_thread);

DESCRIPTION

       The pthread_cancel() function requests that target_thread be canceled.

       By default, cancellation is deferred until target_thread reaches a cancellation point. See cancellation(5).

       Cancellation  cleanup handlers for target_thread are called when the cancellation is acted on. Upon return of the last cancellation cleanup
       handler, the thread-specific data destructor functions are called for target_thread. target_thread is terminated when the  last	destructor
       function returns.

       A  thread  acting on a cancellation request runs with all signals blocked. All thread termination functions, including cancellation cleanup
       handlers and thread-specific data destructor functions, are called with all signals blocked.

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

RETURN VALUES

       If successful, the pthread_cancel() function returns  0. Otherwise, an error number is returned to indicate the error.

ERRORS

       The  pthread_cancel() function may fail if:

       ESRCH	No thread was found with an ID corresponding to that specified by the given thread ID, target_thread.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+
       |Standard		     |See standards(5). 	   |
       +-----------------------------+-----------------------------+

SEE ALSO

       pthread_cleanup_pop(3C), pthread_cleanup_push(3C), pthread_cond_wait(3C), pthread_cond_timedwait(3C),  pthread_exit(3C),  pthread_join(3C),
       pthread_setcancelstate(3C),  pthread_setcanceltype(3C),	pthread_testcancel(3C),  setjmp(3C), attributes(5), cancellation(5), condition(5),
       standards(5)

NOTES

       See cancellation(5) for a discussion of cancellation concepts.

SunOS 5.11							    2 Nov 2007							pthread_cancel(3C)