Requests the cancellation of a thread.
Threads Library (libpthreads.a)
#include <pthread.h>
int pthread_cancel (pthread_t thread);
The pthread_cancel subroutine requests the cancellation of the thread thread. The action depends on the cancelability of the target thread:
The cancellation of a thread terminates it safely, using the same termination procedure as the pthread_exit (pthread_exit Subroutine) subroutine.
Note: The pthread.h header file must be the first included file of each source file using the threads library. Otherwise, the -D_THREAD_SAFE compilation flag should be used, or the cc_r compiler used. In this case, the flag is automatically set.
thread | Specifies the thread to be canceled. |
If successful, the pthread_cancel function returns zero. Otherwise, an error number is returned to indicate the error.
The ptread_cancel
function may fail if:
ESRCH | No thread could be found corresponding to that specified by the given thread ID. |
The pthread_cancel function will not return an error code of EINTR.
This subroutine is part of the Base Operating System (BOS) Runtime.
The pthread_kill (pthread_kill Subroutine) subroutine, pthread_exit (pthread_exit Subroutine) subroutine, pthread_join (pthread_join, or pthread_detach Subroutine) subroutine, pthread_cond_wait (pthread_cond_wait or pthread_cond_timedwait Subroutine), and pthread_cond_timedwait (pthread_cond_wait or pthread_cond_timedwait Subroutine) subroutines.
The pthread.h file.
Terminating Threads in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.
Threads Library Quick Reference in AIX 5L Version 5.1 General Programming Concepts: Writing and Debugging Programs.