pthread_setcanceltype(3T)
NAME
pthread_setcanceltype − set the cancellation type of a thread
SYNOPSIS
#include <pthread.h>
int pthread_setcanceltype(int type, int ∗ oldtype );
DESCRIPTION
pthread_setcanceltype() atomically sets the calling thread’s cancellation type to the specified type and, if oldtype is not NULL, stores the previous cancellation type in oldtype. The type can be either of the following:
PTHREAD_CANCEL_DEFERRED
This is the default. When cancellation is enabled (enabled cancellation is also the default), cancellation occurs when the target thread reaches a cancellation point and a cancel is pending. When cancellation is disabled, all cancellation requests to the target thread are held pending.
PTHREAD_CANCEL_ASYNCHRONOUS
When cancellation is enabled, receipt of a pthread_cancel(3T) call causes immediate cancellation. When cancellation is disabled, all cancellation requests to the target thread are held pending; as soon as cancellation is re-enabled, pending cancellations are executed immediately.
See cancellation(3T) for the definition of a cancellation point. See pthread_setcancelstate(3T) for explanations of enabling and disabling cancellation.
pthread_setcanceltype() is a cancellation point if type is called with PTHREAD_CANCEL_ASYNCHRONOUS and the cancellation state is PTHREAD_CANCEL_ENABLE.
RETURN VALUES
When successful, pthread_setcanceltype() returns 0; otherwise, an error number is returned.
ERRORS
For the following condition, pthread_setcanceltype() returns the corresponding error when the condition is detected:
EINVAL The specified type is not PTHREAD_CANCEL_DEFERRED or PTHREAD_CANCEL_ASYNCHRONOUS.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| MT-Level | MT-Safe |
SEE ALSO
cancellation(3T), condition(3T), pthread_cancel(3T), pthread_cleanup_pop(3T), pthread_cleanup_push(3T), pthread_exit(3T), pthread_join(3T), pthread_setcancelstate(3T), pthread_testcancel(3T), setjmp(3C), attributes(5)
NOTES
See cancellation(3T) for a discussion of cancellation concepts.
SunOS 5.6 — Last change: 7 Jan 1997