pthread_testcancel(3) — Linux manual page

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | ATTRIBUTES | STANDARDS | HISTORY | EXAMPLES | SEE ALSO

pthread_testcancel(3)   Library Functions Manual   pthread_testcancel(3)

NAME         top

       pthread_testcancel - request delivery of any pending cancelation
       request

LIBRARY         top

       POSIX threads library (libpthread, -lpthread)

SYNOPSIS         top

       #include <pthread.h>

       void pthread_testcancel(void);

DESCRIPTION         top

       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         top

       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         top

       This function always succeeds.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌─────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                           Attribute     Value   │
       ├─────────────────────────────────────┼───────────────┼─────────┤
       │ pthread_testcancel()                │ Thread safety │ MT-Safe │
       └─────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       POSIX.1-2008.

HISTORY         top

       glibc 2.0.  POSIX.1-2001.

EXAMPLES         top

       See pthread_cleanup_push(3).

SEE ALSO         top

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

Linux man-pages (unreleased)     (date)            pthread_testcancel(3)

Pages that refer to this page: pthread_cancel(3)pthread_cleanup_push(3)pthread_cleanup_push_defer_np(3)pthread_setcancelstate(3)pthreads(7)