Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_cancel(3c) [opensolaris man page]

pthread_cancel(3C)					   Standard C Library Functions 					pthread_cancel(3C)

NAME
pthread_cancel - cancel execution of a thread SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ] #include <pthread.h> int pthread_cancel(pthread_t target_thread); DESCRIPTION
The pthread_cancel() function requests that target_thread be canceled. By default, cancellation is deferred until target_thread reaches a cancellation point. See cancellation(5). Cancellation cleanup handlers for target_thread are called when the cancellation is acted on. Upon return of the last cancellation cleanup handler, the thread-specific data destructor functions are called for target_thread. target_thread is terminated when the last destructor function returns. A thread acting on a cancellation request runs with all signals blocked. All thread termination functions, including cancellation cleanup handlers and thread-specific data destructor functions, are called with all signals blocked. The cancellation processing in target_thread runs asynchronously with respect to the calling thread returning from pthread_cancel(). RETURN VALUES
If successful, the pthread_cancel() function returns 0. Otherwise, an error number is returned to indicate the error. ERRORS
The pthread_cancel() function may fail if: ESRCH No thread was found with an ID corresponding to that specified by the given thread ID, target_thread. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ |Standard |See standards(5). | +-----------------------------+-----------------------------+ SEE ALSO
pthread_cleanup_pop(3C), pthread_cleanup_push(3C), pthread_cond_wait(3C), pthread_cond_timedwait(3C), pthread_exit(3C), pthread_join(3C), pthread_setcancelstate(3C), pthread_setcanceltype(3C), pthread_testcancel(3C), setjmp(3C), attributes(5), cancellation(5), condition(5), standards(5) NOTES
See cancellation(5) for a discussion of cancellation concepts. SunOS 5.11 2 Nov 2007 pthread_cancel(3C)

Check Out this Related Man Page

pthread_setcancelstate(3C)				   Standard C Library Functions 				pthread_setcancelstate(3C)

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 |MT-Safe | +-----------------------------+-----------------------------+ |Standard |See standards(5). | +-----------------------------+-----------------------------+ 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) SunOS 5.11 22 Jan 2008 pthread_setcancelstate(3C)
Man Page

Featured Tech Videos