summaryrefslogtreecommitdiffstats
path: root/lib/libpthread/man/pthread_cancel.3
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2004-01-14 21:44:26 +0000
committerru <ru@FreeBSD.org>2004-01-14 21:44:26 +0000
commit57b6bbbf56fa1589c1da24f2edb993cc535ce068 (patch)
treeb3a28e39428aba8757379f99bb6e4ede75322ef0 /lib/libpthread/man/pthread_cancel.3
parent894449cd93a70b82e4c6349b4a39db9744f1d10c (diff)
downloadFreeBSD-src-57b6bbbf56fa1589c1da24f2edb993cc535ce068.zip
FreeBSD-src-57b6bbbf56fa1589c1da24f2edb993cc535ce068.tar.gz
Have a single set of POSIX threads man pages. The LIBRARY section
of each manpage lists libraries that have corresponding interfaces implemented. Prodded by: threads Reviewed by: deischen
Diffstat (limited to 'lib/libpthread/man/pthread_cancel.3')
-rw-r--r--lib/libpthread/man/pthread_cancel.381
1 files changed, 0 insertions, 81 deletions
diff --git a/lib/libpthread/man/pthread_cancel.3 b/lib/libpthread/man/pthread_cancel.3
deleted file mode 100644
index ffa5b6d..0000000
--- a/lib/libpthread/man/pthread_cancel.3
+++ /dev/null
@@ -1,81 +0,0 @@
-.\" $FreeBSD$
-.Dd January 17, 1999
-.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
-The
-.Fn pthread_cancel
-function will 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
-The
-.Fn pthread_cancel
-function 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 .
OpenPOWER on IntegriCloud