Standard C Library Functions pthreadsetcancelstate(3C)
NAME
pthreadsetcancelstate - enable or disable cancellation
SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ]
#include
int pthreadsetcancelstate(int state, int *oldstate);
DESCRIPTION
The pthreadsetcancelstate() function atomically sets the
calling thread's cancellation state to the specified state
and if oldstate is not NUL, stores the previous cancella-
tion state in oldstate.
The state can be either of the following:
PTHREADCANCELENABLE
This is the default. When cancellation is deferred
(deferred cancellation is also the default), cancella-
tion occurs when the target thread reaches a cancella-
tion point and a cancel is pending. When cancellation is
asynchronous, receipt of a pthreadcancel(3C) call
causes immediate cancellation.
PTHREADCANCELDISABLE
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
pthreadsetcanceltype(3C) for explanations of deferred and
asynchronous cancellation.
RETURN VALUES
Upon successful completion, pthreadsetcancelstate(),
returns 0. Otherwise, an error number is returned to indi-
cate the error.
ERORS
The pthreadsetcancelstate() function will fail if:
SunOS 5.11 Last change: 22 Jan 2008 1
Standard C Library Functions pthreadsetcancelstate(3C)
EINVAL The specified state is not PTHREADCANCELENABLE
or PTHREADCANCELDISABLE.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
Standard See standards(5).
SEE ALSO
pthreadcancel(3C), pthreadcleanuppop(3C),
pthreadcleanuppush(3C), pthreadexit(3C),
pthreadjoin(3C), pthreadsetcanceltype(3C),
pthreadtestcancel(3C), setjmp(3C), attributes(5), cancella-
tion(5), condition(5), standards(5)
SunOS 5.11 Last change: 22 Jan 2008 2
|