NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO
$(OS_DIR)/lib/libpthreads.a #include <pthread.h>int pthread_cancel(pthread_t target_thread);
The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.
See API(5FEA) for details.
The pthread_cancel() function requests that target_thread be canceled.
By default, cancellation is deferred until target_thread reaches a cancellation point. See cancellation(3POSIX).
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.
The cancellation processing in target_thread runs asynchronously with respect to the calling thread returning from pthread_cancel().
If successful, the pthread_cancel() function returns 0. Otherwise, an error number is returned to indicate the error.
The pthread_cancel() function may fail if:
No thread was found with an ID corresponding to that specified by the given thread ID, target_thread.
See attributes(5)for descriptions of the following attributes:
ATTRIBUTE TYPE | ATTRIBUTE VALUE |
---|---|
Interface Stability | Evolving |
cancellation(3POSIX), pthread_cleanup_pop(3POSIX), pthread_cleanup_push(3POSIX), pthread_cond_wait(3POSIX), pthread_cond_timedwait(3POSIX), pthread_exit(3POSIX), pthread_join(3POSIX), pthread_setcancelstate(3POSIX), pthread_setcanceltype(3POSIX), pthread_testcancel(3POSIX), setjmp(3STDC)
NAME | SYNOPSIS | API RESTRICTIONS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO