Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_cancel(3) [osf1 man page]

pthread_cancel(3)					     Library Functions Manual						 pthread_cancel(3)

NAME
pthread_cancel - Allows a thread to request a thread to terminate execution. LIBRARY
DECthreads POSIX 1003.1c Library (libpthread.so) SYNOPSIS
#include <pthread.h> int pthread_cancel( pthread_t thread); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: IEEE Std 1003.1c-1995, POSIX System Application Program Interface PARAMETERS
Thread that receives a cancelation request. DESCRIPTION
This routine sends a cancelation request to the specified target thread. A cancelation request is a mechanism by which a calling thread requests the target thread to terminate as quickly as possible. Issuing a cancelation request does not guarantee that the target thread will receive or handle the request. When the cancelation request is acted on, all active cleanup handler routines for the target thread are called. When the last cleanup han- dler returns, the thread-specific data destructor routines are called for each thread-specific data key with a destructor and for which the target thread has a non-NULL value. Finally, the target thread is terminated. Note that cancelation of the target thread runs asynchronously with respect to the calling thread's returning from pthread_cancel(3). The target thread's cancelability state and type determine when or if the cancelation takes place, as follows: The target thread can delay can- celation during critical operations by setting its cancelability state to PTHREAD_CANCEL_DISABLE. Because of communication delays, the calling thread can only rely on the fact that a cancelation request will eventually become pending in the target thread (provided that the target thread does not terminate beforehand). The calling thread has no guarantee that a pending cancelation request will be delivered because delivery is controlled by the target thread. When a cancelation request is delivered to a thread, termination processing is similar to that for pthread_exit(3). For more information about thread termination, see the discussion of thread termination in pthread_create(3). This routine is preferred in implementing an Ada abort statement and any other language- or software-defined construct for requesting thread cancelation. The results of this routine are unpredictable, if the value specified in thread refers to a thread that does not currently exist. RETURN VALUES
If an error condition occurs, this routine returns an integer value indicating the type of error. Possible return values are as follows: Successful completion. The specified thread is invalid. The thread argument does not specify an existing thread. ERRORS
None RELATED INFORMATION
Functions: pthread_cleanup_pop(3), pthread_cleanup_push(3), pthread_create(3), pthread_exit(3), pthread_join(3), pthread_setcancelstate(3), pthread_setcanceltype(3), pthread_testcancel(3) Manuals: Guide to DECthreads and Programmer's Guide delim off pthread_cancel(3)

Check Out this Related Man Page

pthread_join(3C)														  pthread_join(3C)

NAME
pthread_join - wait for thread termination SYNOPSIS
cc -mt [ flag... ] file... -lpthread [ library... ] #include <pthread.h> int pthread_join(pthread_t thread, void **status); The pthread_join() function suspends processing of the calling thread until the target thread completes. thread must be a member of the current process and it cannot be a detached thread. See pthread_create(3C). If two or more threads wait for the same thread to complete, all will suspend processing until the thread has terminated, and then one thread will return successfully and the others will return with an error of ESRCH. The pthread_join() function will not block processing of the calling thread if the target thread has already terminated. If a pthread_join() call returns successfully with a non-null status argument, the value passed to pthread_exit(3C) by the terminating thread will be placed in the location referenced by status. If the pthread_join() calling thread is cancelled, then the target thread will remain joinable by pthread_join(). However, the calling thread may set up a cancellation cleanup handler on thread prior to the join call, which may detach the target thread by calling pthread_detach(3C). See pthread_detach(3C) and pthread_cancel(3C). If successful, pthread_join() returns 0. Otherwise, an error number is returned to indicate the error. EDEADLK A joining deadlock would occur, such as when a thread attempts to wait for itself. EINVAL The thread corresponding to the given thread ID is a detached thread. ESRCH No thread could be found corresponding to the given thread ID. See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ pthread_cancel(3C), pthread_create(3C), pthread_detach(3C), pthread_exit(3C), wait(3C), attributes(5), standards(5) The pthread_join(3C) function must specify the thread ID for whose termination it will wait. Calling pthread_join() also "detaches" the thread; that is, pthread_join() includes the effect of the pthread_detach() function. If a thread were to be cancelled when blocked in pthread_join(), an explicit detach would have to be performed in the cancellation cleanup han- dler. The pthread_detach() function exists primarily for this purpose. 23 Mar 2005 pthread_join(3C)
Man Page

Featured Tech Videos