share/man/man3c/pthread_testcancel.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright (c) 2005, Sun Microsystems, Inc.  All Rights Reserved.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_TESTCANCEL 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_testcancel \- create cancellation point in the calling thread
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  19 #include <pthread.h>
  20
  21 \fBvoid\fR \fBpthread_testcancel\fR(\fBvoid\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBpthread_testcancel()\fR function forces testing for cancellation. This
  28 is useful  when you need to execute code that runs for long periods without
  29 encountering cancellation points; such as a library routine that executes
  30 long-running computations without cancellation points. This type of code can
  31 block cancellation for unacceptable long periods of time.   One strategy for
  32 avoiding blocking cancellation for long periods, is to insert calls to
  33 \fBpthread_testcancel()\fR in the long-running computation code and to setup a
  34 cancellation handler in the library code, if required.
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The \fBpthread_testcancel()\fR function returns \fBvoid\fR.
  39 .SH ERRORS
  40 .sp
  41 .LP
  42 The \fBpthread_testcancel()\fR function does not return errors.
  43 .SH EXAMPLES
  44 .sp
  45 .LP
  46 See \fBcancellation\fR(5) for an example of using \fBpthread_testcancel()\fR to
  47 force testing for cancellation and a discussion of cancellation concepts.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Standard
  62 _
  63 MT-Level        MT-Safe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBIntro\fR(3), \fBpthread_cleanup_pop\fR(3C), \fBpthread_cleanup_push\fR(3C),
  70 \fBpthread_exit\fR(3C), \fBpthread_join\fR(3C),
  71 \fBpthread_setcancelstate\fR(3C), \fBpthread_setcanceltype\fR(3C),
  72 \fBsetjmp\fR(3C), \fBattributes\fR(5), \fBcancellation\fR(5),
  73 \fBcondition\fR(5), \fBstandards\fR(5)
  74 .SH NOTES
  75 .sp
  76 .LP
  77 The \fBpthread_testcancel()\fR function has no effect if cancellation is
  78 disabled.
  79 .sp
  80 .LP
  81 Use \fBpthread_testcancel()\fR with \fBpthread_setcanceltype()\fR called with
  82 its \fIcanceltype\fR set to \fBPTHREAD_CANCEL_DEFERRED\fR. The
  83 \fBpthread_testcancel()\fR function operation is undefined if
  84 \fBpthread_setcanceltype()\fR was called with its \fIcanceltype\fR argument set
  85 to \fBPTHREAD_CANCEL_ASYNCHRONOUS\fR.
  86 .sp
  87 .LP
  88 It is possible to kill a thread when it is holding a resource, such as lock or
  89 allocated memory. If that thread has not setup a cancellation cleanup handler
  90 to release the held resource, the application is "cancel-unsafe".  See
  91 \fBattributes\fR(5) for a discussion of Cancel-Safety, Deferred-Cancel-Safety,
  92 and Asynchronous-Cancel-Safety.