Content-type: text/html
Man page of pthread_setcancelstate
pthread_setcancelstate
Section: Standard C Library Functions (3C)
Updated: 22 Jan 2008
Index
Return to Main Contents
NAME
pthread_setcancelstate - enable or disable cancellation
SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ]
#include <pthread.h>
int pthread_setcancelstate(int state, int *oldstate);
DESCRIPTION
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.
RETURN VALUES
Upon successful completion, pthread_setcancelstate(), returns 0. Otherwise, an error number is returned to indicate the error.
ERRORS
The pthread_setcancelstate() function will fail if:
EINVAL
-
The specified state is not PTHREAD_CANCEL_ENABLE or PTHREAD_CANCEL_DISABLE.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE
|
|
| Interface Stability | Committed
|
|
| MT-Level |
|
| Standard |
|
SEE ALSO
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)
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- ERRORS
-
- ATTRIBUTES
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 02:37:25 GMT, October 02, 2010