pthread_setcanceltype(3C)Standard C Library Functionspthread_setcanceltype(3C)NAMEpthread_setcanceltype - set cancellation type of a thread
SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ]
#include <pthread.h>
int pthread_setcanceltype(int type, int *oldtype);
DESCRIPTION
The pthread_setcanceltype() function 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 can‐
cellation point and a cancel is pend‐
ing. 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(3C) call causes
immediate cancellation. When cancella‐
tion is disabled, all cancellation
requests to the target thread are held
pending; as soon as cancellation is re-
enabled, pending cancellations are exe‐
cuted immediately.
See cancellation(5) for the definition of a cancellation point and a
discussion of cancellation concepts. See pthread_setcancelstate(3C) for
explanations of enabling and disabling cancellation.
The pthread_setcanceltype() function is a cancellation point if type is
called with PTHREAD_CANCEL_ASYNCHRONOUS and the cancellation state is
PTHREAD_CANCEL_ENABLE.
RETURN VALUES
Upon successful completion, the pthread_setcanceltype() function
returns 0. Otherwise, an error number is returned to indicate the
error.
ERRORS
The pthread_setcanceltype() function will fail if:
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 │
├─────────────────────────────┼─────────────────────────────┤
│Interface Stability │Standard │
├─────────────────────────────┼─────────────────────────────┤
│MT-Level │MT-Safe │
└─────────────────────────────┴─────────────────────────────┘
SEE ALSOpthread_cancel(3C), pthread_cleanup_pop(3C), pthread_cleanup_push(3C),
pthread_exit(3C), pthread_join(3C), pthread_setcancelstate(3C),
pthread_testcancel(3C), setjmp(3C), attributes(5), cancellation(5),
condition(5), standards(5)SunOS 5.10 23 Mar 2005 pthread_setcanceltype(3C)
