pthread_testcancel(3) [bsd man page]

PTHREAD_TESTCANCEL(3)					     Linux Programmer's Manual					     PTHREAD_TESTCANCEL(3)

NAME

       pthread_testcancel - request delivery of any pending cancellation request

SYNOPSIS

       #include <pthread.h>

       void pthread_testcancel(void);

       Compile and link with -pthread.

DESCRIPTION

       Calling pthread_testcancel() creates a cancellation point within the calling thread, so that a thread that is otherwise executing code that
       contains no cancellation points will respond to a cancellation request.

       If cancelability is disabled (using pthread_setcancelstate(3)), or no cancellation request is pending, then a call to  pthread_testcancel()
       has no effect.

RETURN VALUE

       This  function  does  not return a value.  If the calling thread is canceled as a consequence of a call to this function, then the function
       does not return.

ERRORS

       This function always succeeds.

ATTRIBUTES

       For an explanation of the terms used in this section, see attributes(7).

       +---------------------+---------------+---------+
       |Interface	     | Attribute     | Value   |
       +---------------------+---------------+---------+
       |pthread_testcancel() | Thread safety | MT-Safe |
       +---------------------+---------------+---------+
CONFORMING TO

       POSIX.1-2001, POSIX.1-2008.

EXAMPLE

       See pthread_cleanup_push(3).

SEE ALSO

       pthread_cancel(3), pthread_cleanup_push(3), pthread_setcancelstate(3), pthreads(7)

COLOPHON

       This page is part of release 4.15 of the Linux man-pages project.  A description of the project, information about reporting bugs, and  the
       latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

Linux								    2017-09-15						     PTHREAD_TESTCANCEL(3)

pthread_setcancelstate(3C)												pthread_setcancelstate(3C)

NAME

       pthread_setcancelstate - enable or disable cancellation

SYNOPSIS

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

       int pthread_setcancelstate(int state, int *oldstate);

       The pthread_setcancelstate() function atomically sets the calling thread's cancellation state to the specified state and if oldstate is not
       NULL, stores the previous cancellation state in oldstate.

       The state can be either of the following:

       PTHREAD_CANCEL_ENABLE   This is the default. When cancellation is deferred (deferred cancellation is also the default), cancellation occurs
			       when  the  target  thread  reaches a cancellation point and a cancel is pending. When cancellation is asynchronous,
			       receipt of a  pthread_cancel(3C) call causes immediate cancellation.

       PTHREAD_CANCEL_DISABLE  When cancellation is deferred, all cancellation requests to the target thread are held pending.	When  cancellation
			       is  asynchronous,  all  cancellation requests to the target thread are held pending; as soon as cancellation is re-
			       enabled, pending cancellations are executed immediately.

       See cancellation(5) for the definition of a cancellation point and a discussion of cancellation concepts. See pthread_setcanceltype(3C) for
       explanations of deferred and asynchronous cancellation.

       The  pthread_setcancelstate()  function is a cancellation point when it	is called with	PTHREAD_CANCEL_ENABLE and the cancellation type is
       PTHREAD_CANCEL_ASYNCHRONOUS.

       Upon successful completion, pthread_setcancelstate(), returns 0. Otherwise, an error number is returned to indicate the error.

       The pthread_setcancelstate() function will fail if:

       EINVAL	       The specified state is not PTHREAD_CANCEL_ENABLE or PTHREAD_CANCEL_DISABLE.

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

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

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

								    23 Mar 2005 					pthread_setcancelstate(3C)