usr/src/man/man3c/pthread_setcanceltype.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright (c) 1995 IEEE.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_SETCANCELTYPE 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_setcanceltype \- set cancellation type of a thread
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  54 #include <pthread.h>
  55
  56 \fBint\fR \fBpthread_setcanceltype\fR(\fBint\fR \fItype\fR, \fBint *\fR\fIoldtype\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 The \fBpthread_setcanceltype()\fR function atomically sets the calling thread's
  63 cancellation type to the specified \fBtype\fR and, if  \fIoldtype\fR is not
  64 \fINULL,\fR stores the previous cancellation \fBtype\fR in  \fIoldtype\fR. The
  65 \fBtype\fR can be either of the following:
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBPTHREAD_CANCEL_DEFERRED\fR \fR
  70 .ad
  71 .sp .6
  72 .RS 4n
  73 This is the default. When cancellation is enabled (enabled cancellation is also
  74 the default), cancellation occurs when the target thread reaches a cancellation
  75 point and a cancel is pending. When cancellation is disabled, all cancellation
  76 requests to the target thread are held pending.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBPTHREAD_CANCEL_ASYNCHRONOUS\fR \fR
  83 .ad
  84 .sp .6
  85 .RS 4n
  86 When cancellation is enabled, receipt of a  \fBpthread_cancel\fR(3C) call
  87 causes immediate cancellation. When cancellation is disabled, all cancellation
  88 requests to the target thread are held pending; as soon as cancellation is
  89 re-enabled, pending cancellations are executed immediately.
  90 .RE
  91
  92 .sp
  93 .LP
  94 See \fBcancellation\fR(5) for the definition of a cancellation point and a
  95 discussion of cancellation concepts. See \fBpthread_setcancelstate\fR(3C) for
  96 explanations of enabling and disabling cancellation.
  97 .sp
  98 .LP
  99 The \fBpthread_setcanceltype()\fR function is a cancellation point if
 100 \fBtype\fR is called with \fBPTHREAD_CANCEL_ASYNCHRONOUS\fR and the
 101 cancellation state is \fBPTHREAD_CANCEL_ENABLE.\fR
 102 .SH RETURN VALUES
 103 .sp
 104 .LP
 105 Upon successful completion, the  \fBpthread_setcanceltype()\fR function returns
 106 \fB0\fR. Otherwise, an error number is returned to indicate the error.
 107 .SH ERRORS
 108 .sp
 109 .LP
 110 The  \fBpthread_setcanceltype()\fR function will fail if:
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBEINVAL\fR \fR
 115 .ad
 116 .RS 11n
 117 The specified \fBtype\fR is not \fBPTHREAD_CANCEL_DEFERRED\fR or
 118 \fBPTHREAD_CANCEL_ASYNCHRONOUS.\fR
 119 .RE
 120
 121 .SH ATTRIBUTES
 122 .sp
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Standard
 135 _
 136 MT-Level        MT-Safe
 137 .TE
 138
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBpthread_cancel\fR(3C), \fBpthread_cleanup_pop\fR(3C),
 143 \fBpthread_cleanup_push\fR(3C), \fBpthread_exit\fR(3C), \fBpthread_join\fR(3C),
 144 \fBpthread_setcancelstate\fR(3C), \fBpthread_testcancel\fR(3C),
 145 \fBsetjmp\fR(3C), \fBattributes\fR(5), \fBcancellation\fR(5),
 146 \fBcondition\fR(5), \fBstandards\fR(5)