man3/pthread_testcancel.3

   1 '\" t
   2 .\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   6 .\"
   7 .TH pthread_testcancel 3 (date) "Linux man-pages (unreleased)"
   8 .SH NAME
   9 pthread_testcancel \- request delivery of any pending cancelation request
  10 .SH LIBRARY
  11 POSIX threads library
  12 .RI ( libpthread ", " \-lpthread )
  13 .SH SYNOPSIS
  14 .nf
  15 .B #include <pthread.h>
  16 .PP
  17 .B void pthread_testcancel(void);
  18 .fi
  19 .SH DESCRIPTION
  20 Calling
  21 .BR pthread_testcancel ()
  22 creates a cancelation point within the calling thread,
  23 so that a thread that is otherwise executing code that contains
  24 no cancelation points will respond to a cancelation request.
  25 .PP
  26 If cancelability is disabled (using
  27 .BR pthread_setcancelstate (3)),
  28 or no cancelation request is pending,
  29 then a call to
  30 .BR pthread_testcancel ()
  31 has no effect.
  32 .SH RETURN VALUE
  33 This function does not return a value.
  34 If the calling thread is canceled as a consequence of a call
  35 to this function, then the function does not return.
  36 .SH ERRORS
  37 This function always succeeds.
  38 .\" SH VERSIONS
  39 .\" Available since glibc 2.0
  40 .SH ATTRIBUTES
  41 For an explanation of the terms used in this section, see
  42 .BR attributes (7).
  43 .ad l
  44 .nh
  45 .TS
  46 allbox;
  47 lbx lb lb
  48 l l l.
  49 Interface       Attribute       Value
  50 T{
  51 .BR pthread_testcancel ()
  52 T}      Thread safety   MT-Safe
  53 .TE
  54 .hy
  55 .ad
  56 .sp 1
  57 .SH STANDARDS
  58 POSIX.1-2001, POSIX.1-2008.
  59 .SH EXAMPLES
  60 See
  61 .BR pthread_cleanup_push (3).
  62 .SH SEE ALSO
  63 .BR pthread_cancel (3),
  64 .BR pthread_cleanup_push (3),
  65 .BR pthread_setcancelstate (3),
  66 .BR pthreads (7)