Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_cancel(3t) [hpux man page]

pthread_cancel(3T)														pthread_cancel(3T)

NAME
pthread_cancel() - cancel execution of a thread SYNOPSIS
PARAMETERS
thread Target thread to be canceled. DESCRIPTION
requests that thread (hereby referred to as target thread) be canceled. It allows a thread to terminate the execution of any thread in the process in a controlled manner. The target thread's cancelability state and type determine when the cancellation takes effect. Cancellation only occurs when the target thread's cancelability state is When the target thread's cancelability state is cancellation requests against the target thread are held pending and will be acted upon when cancellation is enabled. When the cancelability type is for the target thread, new or pending cancellation requests are acted upon at any time. When the target thread's cancelability type is cancellation requests are held pending until the target thread reaches a cancellation point (see below). If the target thread's cancelability state is disabled, the cancelability type does not matter. When cancelability is enabled, the cance- lability type will take effect. When the cancellation is acted on, the cancellation cleanup handlers for thread are called. The cancellation cleanup handlers are called in the opposite order in which they were installed. When the last cancellation cleanup handler returns, the thread-specific data destruc- tor functions for thread are called. When the last destructor function returns, thread shall be terminated. The caller of will not wait for the target thread to be canceled. Cancellation Points are points inside of certain functions where a thread must act on any pending cancellation request when cancelability is enabled if the function would block. RETURN VALUE
Upon successful completion, returns zero. Otherwise, an error number is returned to indicate the error (the variable is not set). ERRORS
For each of the following conditions, if the condition is detected, the function returns the corresponding error number: [ESRCH] No thread could be found corresponding to thread. WARNINGS
Use of asynchronous cancelability while holding resources that need to be released may result in resource loss. Applications must care- fully follow static lexical scoping rules in their execution behavior. For instance, the use of return, goto, etc., to leave user-defined cancellation scopes without doing the necessary scope pop will result in undefined behavior. AUTHOR
was derived from the IEEE POSIX P1003.1c standard. SEE ALSO
pthread_exit(3T), pthread_join(3T), pthread_setcancelstate(3T), pthread_cleanup_pop(3T), pthread_cond_wait(3T). STANDARDS CONFORMANCE
Pthread Library pthread_cancel(3T)

Check Out this Related Man Page

pthread_setcancelstate(3T)												pthread_setcancelstate(3T)

NAME
pthread_setcancelstate(), pthread_setcanceltype() - set and retrieve current thread's cancelability state or type. SYNOPSIS
PARAMETERS
state Value to which the cancelability state of the calling thread is to be set. oldstate Pointer to the location where the old cancelability state of the calling thread will be returned. type Value to which the cancelability type of the calling thread is to be set. oldtype Pointer to the location where the old cancelability type of the calling thread will be returned. DESCRIPTION
atomically sets the calling thread's cancelability state to the value in state and returns the previous cancelability state in oldstate. The legal values for state are: Disable cancelability for the calling thread. Cancellation requests against the calling thread are held pending. Enable cancelability for the calling thread. Cancellation requests against the calling thread may be acted upon. When a pending cancellation request will be acted upon depends on the thread's cancelability type. By default, a thread's cancelability state is set to when it is created. atomically sets the calling thread's cancelability type to the value in type and returns the previous cancelability type in oldtype. The legal values for type are: New or pending cancellation requests against the calling thread may be acted upon at any time (if cancellation is enabled for the calling thread). Cancellation requests for the calling thread are held pending until a cancellation point is reached. A thread's cancelability type is set to when it is created. If a thread's cancelability state is disabled, the setting of the thread's cancelability type has no immediate effect. All cancellation requests are held pending. However, once cancelability is enabled again, the new type will be in effect. RETURN VALUE
Upon successful completion, and return zero. Otherwise, an error number is returned to indicate the error (the variable is not set). ERRORS
For each of the following conditions, if the condition is detected, the and functions return the corresponding error number: [EINVAL] state contains an invalid value. [EINVAL] type contains an invalid value. NOTES
Only functions that are async-cancel safe should be called from a thread that is asynchronously cancelable. AUTHOR
and were derived from the IEEE POSIX P1003.1c standard. SEE ALSO
pthread_exit(3T), pthread_join(3T), pthread_cancel(3T), pthread_cond_wait(3T), pthread_cond_timedwait(3T). STANDARDS CONFORMANCE
Pthread Library pthread_setcancelstate(3T)
Man Page

Featured Tech Videos