NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO
$(OS_DIR)/lib/libpthreads.a #include <pthread.h>int pthread_setcanceltype(int type, int *oldtype);
The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.
See API(5FEA) for details.
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:
This is the default type. 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.
When cancellation is enabled, receipt of a pthread_cancel(3POSIX) 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(3POSIX) for the definition of a cancellation point and a discussion of cancellation concepts. See pthread_setcancelstate(3POSIX) 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.
Upon successful completion, the pthread_setcanceltype() function, returns 0. Otherwise, an error number is returned to indicate the error.
The pthread_setcanceltype() function will fail if:
The specified type is not PTHREAD_CANCEL_DEFERRED or PTHREAD_CANCEL_ASYNCHRONOUS.
See attributes(5)for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Evolving |
cancellation(3POSIX), pthread_cancel(3POSIX), pthread_cleanup_pop(3POSIX), pthread_cleanup_push(3POSIX), pthread_exit(3POSIX), pthread_join(3POSIX), pthread_setcancelstate(3POSIX), pthread_testcancel(3POSIX),
NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO