pthread_testcancel - Man Page

request delivery of any pending cancelation request

Library

POSIX threads library (libpthread, -lpthread)

Synopsis

#include <pthread.h>

void pthread_testcancel(void);

Description

Calling pthread_testcancel() creates a cancelation point within the calling thread, so that a thread that is otherwise executing code that contains no cancelation points will respond to a cancelation request.

If cancelability is disabled (using pthread_setcancelstate(3)), or no cancelation request is pending, then a call to pthread_testcancel() has no effect.

Return Value

This function does not return a value. If the calling thread is canceled as a consequence of a call to this function, then the function does not return.

Errors

This function always succeeds.

Attributes

For an explanation of the terms used in this section, see attributes(7).

InterfaceAttributeValue
pthread_testcancel()Thread safetyMT-Safe

Standards

POSIX.1-2008.

History

glibc 2.0. POSIX.1-2001.

Examples

See pthread_cleanup_push(3).

See Also

pthread_cancel(3), pthread_cleanup_push(3), pthread_setcancelstate(3), pthreads(7)

Referenced By

pthread_cancel(3), pthread_cleanup_push(3), pthread_cleanup_push_defer_np(3), pthread_key_create(3), pthreads(7), pthread_setcancelstate(3).

2024-05-02 Linux man-pages 6.9.1