2003-06-08 10:44:28 +04:00
|
|
|
.\" $NetBSD: pthread_cancel.3,v 1.2 2003/06/08 06:44:29 thorpej Exp $
|
2003-06-04 01:33:06 +04:00
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\" 3. Neither the name of The NetBSD Foundation nor the names of its
|
|
|
|
|
.\" contributors may be used to endorse or promote products derived
|
|
|
|
|
.\" from this software without specific prior written permission.
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
|
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
|
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
|
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
|
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD: src/lib/libpthread/man/pthread_cancel.3,v 1.7 2002/09/16 19:29:28 mini Exp $
|
|
|
|
|
.Dd January 30, 2003
|
|
|
|
|
.Dt PTHREAD_CANCEL 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm pthread_cancel
|
|
|
|
|
.Nd cancel execution of a thread
|
|
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libpthread
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In pthread.h
|
|
|
|
|
.Ft int
|
|
|
|
|
.Fn pthread_cancel "pthread_t thread"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn pthread_cancel
|
|
|
|
|
function requests that
|
|
|
|
|
.Fa thread
|
|
|
|
|
be canceled.
|
|
|
|
|
The target thread's cancelability state and type determines
|
|
|
|
|
when the cancellation takes effect.
|
|
|
|
|
When the cancellation is acted on,
|
|
|
|
|
the cancellation cleanup handlers for
|
|
|
|
|
.Fa thread
|
|
|
|
|
are called.
|
|
|
|
|
When the last cancellation cleanup handler returns,
|
|
|
|
|
the thread-specific data destructor functions will be called for
|
|
|
|
|
.Fa thread .
|
|
|
|
|
When the last destructor function returns,
|
|
|
|
|
.Fa thread
|
|
|
|
|
will be terminated.
|
|
|
|
|
.Pp
|
|
|
|
|
The cancellation processing in the target thread runs asynchronously with
|
|
|
|
|
respect to the calling thread returning from
|
|
|
|
|
.Fn pthread_cancel .
|
|
|
|
|
.Pp
|
|
|
|
|
A status of
|
|
|
|
|
.Dv PTHREAD_CANCELED
|
|
|
|
|
is made available to any threads joining with the target.
|
|
|
|
|
The symbolic
|
|
|
|
|
constant
|
|
|
|
|
.Dv PTHREAD_CANCELED
|
|
|
|
|
expands to a constant expression of type
|
|
|
|
|
.Ft (void *) ,
|
|
|
|
|
whose value matches no pointer to an object in memory nor the value
|
|
|
|
|
.Dv NULL .
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
If successful, the
|
|
|
|
|
.Fn pthread_cancel
|
|
|
|
|
functions will return zero.
|
|
|
|
|
Otherwise an error number will be returned to
|
|
|
|
|
indicate the error.
|
|
|
|
|
.Sh ERRORS
|
|
|
|
|
.Fn pthread_cancel
|
|
|
|
|
may fail if:
|
|
|
|
|
.Bl -tag -width Er
|
|
|
|
|
.It Bq Er ESRCH
|
|
|
|
|
No thread could be found corresponding to that specified by the given
|
|
|
|
|
thread ID.
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr pthread_cleanup_pop 3 ,
|
|
|
|
|
.Xr pthread_cleanup_push 3 ,
|
|
|
|
|
.Xr pthread_exit 3 ,
|
|
|
|
|
.Xr pthread_join 3 ,
|
|
|
|
|
.Xr pthread_setcancelstate 3 ,
|
|
|
|
|
.Xr pthread_setcanceltype 3 ,
|
|
|
|
|
.Xr pthread_testcancel 3
|
|
|
|
|
.Sh STANDARDS
|
|
|
|
|
.Fn pthread_cancel
|
|
|
|
|
conforms to
|
|
|
|
|
.St -p1003.1-96 .
|
|
|
|
|
.Sh AUTHORS
|
|
|
|
|
This man page was written by
|
|
|
|
|
.An David Leonard Aq d@openbsd.org
|
|
|
|
|
for the
|
|
|
|
|
.Ox
|
|
|
|
|
implementation of
|
|
|
|
|
.Fn pthread_cancel .
|
