2008-11-14 18:59:17 +00:00
|
|
|
.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
|
|
|
|
.\" <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
2012-04-14 01:13:04 +00:00
|
|
|
.TH PTHREAD_TESTCANCEL 3 2012-04-14 "Linux" "Linux Programmer's Manual"
|
2008-11-14 18:59:17 +00:00
|
|
|
.SH NAME
|
|
|
|
pthread_testcancel \- request delivery of any pending cancellation request
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
|
|
|
.B void pthread_testcancel(void);
|
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
add_key.2, keyctl.2, request_key.2, offsetof.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_cleanup_push_defer_np.3, pthread_equal.3, pthread_exit.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_self.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, pthread_testcancel.3: Global formatting fix: balance .nf/.fi pairs
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-03-12 15:37:22 +00:00
|
|
|
.fi
|
2008-11-14 18:59:17 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
Calling
|
|
|
|
.BR pthread_testcancel ()
|
|
|
|
creates a cancellation point within the calling thread,
|
|
|
|
so that a thread that is otherwise executing code that contains
|
|
|
|
no cancellation points will respond to a cancellation request.
|
|
|
|
|
|
|
|
If cancelability is disabled (using
|
|
|
|
.BR pthread_setcancelstate (3)),
|
|
|
|
or no cancellation request is pending,
|
|
|
|
then a call to
|
2013-02-12 10:20:12 +00:00
|
|
|
.BR pthread_testcancel ()
|
2008-11-14 18:59:17 +00:00
|
|
|
has no effect.
|
|
|
|
.SH 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.
|
|
|
|
.SH ERRORS
|
|
|
|
This function always succeeds.
|
|
|
|
.\" SH VERSIONS
|
|
|
|
.\" Available since glibc 2.0
|
|
|
|
.SH CONFORMING TO
|
|
|
|
POSIX.1-2001.
|
|
|
|
.SH EXAMPLE
|
|
|
|
See
|
|
|
|
.BR pthread_cleanup_push (3).
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR pthread_cancel (3),
|
|
|
|
.BR pthread_cleanup_push (3),
|
|
|
|
.BR pthread_setcancelstate (3),
|
|
|
|
.BR pthreads (7)
|