pthread_testcancel(3) — Linux manual page

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)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02          pthread_testcancel(3)

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

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.