17285bccfSAlfred Perlstein.\" $FreeBSD$ 27285bccfSAlfred Perlstein.Dd January 17, 1999 37285bccfSAlfred Perlstein.Dt PTHREAD_CANCEL 3 47285bccfSAlfred Perlstein.Os 57285bccfSAlfred Perlstein.Sh NAME 67285bccfSAlfred Perlstein.Nm pthread_cancel 77285bccfSAlfred Perlstein.Nd cancel execution of a thread 87285bccfSAlfred Perlstein.Sh SYNOPSIS 97285bccfSAlfred Perlstein.Fd #include <pthread.h> 107285bccfSAlfred Perlstein.Ft int 117285bccfSAlfred Perlstein.Fn pthread_cancel "pthread_t thread" 127285bccfSAlfred Perlstein.Sh DESCRIPTION 137285bccfSAlfred PerlsteinThe 147285bccfSAlfred Perlstein.Fn pthread_cancel 157285bccfSAlfred Perlsteinfunction requests that 167285bccfSAlfred Perlstein.Fa thread 17c6ff3a1bSSheldon Hearnbe canceled. 18c6ff3a1bSSheldon HearnThe target thread's cancelability state and type determines 19c6ff3a1bSSheldon Hearnwhen the cancellation takes effect. 20c6ff3a1bSSheldon HearnWhen the cancellation is acted on, 217285bccfSAlfred Perlsteinthe cancellation cleanup handlers for 227285bccfSAlfred Perlstein.Fa thread 23c6ff3a1bSSheldon Hearnare called. 24c6ff3a1bSSheldon HearnWhen the last cancellation cleanup handler returns, 257285bccfSAlfred Perlsteinthe thread-specific data destructor functions will be called for 267285bccfSAlfred Perlstein.Fa thread . 277285bccfSAlfred PerlsteinWhen the last destructor function returns, 287285bccfSAlfred Perlstein.Fa thread 297285bccfSAlfred Perlsteinwill be terminated. 307285bccfSAlfred Perlstein.Pp 317285bccfSAlfred PerlsteinThe cancellation processing in the target thread runs asynchronously with 327285bccfSAlfred Perlsteinrespect to the calling thread returning from 337285bccfSAlfred Perlstein.Fn pthread_cancel . 347285bccfSAlfred Perlstein.Pp 357285bccfSAlfred PerlsteinA status of 367285bccfSAlfred Perlstein.Dv PTHREAD_CANCELED 37c6ff3a1bSSheldon Hearnis made available to any threads joining with the target. 38c6ff3a1bSSheldon HearnThe symbolic 397285bccfSAlfred Perlsteinconstant 407285bccfSAlfred Perlstein.Dv PTHREAD_CANCELED 417285bccfSAlfred Perlsteinexpands to a constant expression of type 427285bccfSAlfred Perlstein.Ft "(void *)" , 437285bccfSAlfred Perlsteinwhose value matches no pointer to an object in memory nor the value 447285bccfSAlfred Perlstein.Dv NULL . 457285bccfSAlfred Perlstein.Sh RETURN VALUES 467285bccfSAlfred PerlsteinIf successful, the 477285bccfSAlfred Perlstein.Fn pthread_cancel 48c6ff3a1bSSheldon Hearnfunctions will return zero. 49c6ff3a1bSSheldon HearnOtherwise an error number will be returned to 507285bccfSAlfred Perlsteinindicate the error. 517285bccfSAlfred Perlstein.Sh ERRORS 527285bccfSAlfred Perlstein.Fn pthread_cancel 537285bccfSAlfred Perlsteinwill fail if: 547285bccfSAlfred Perlstein.Bl -tag -width Er 557285bccfSAlfred Perlstein.It Bq Er ESRCH 567285bccfSAlfred PerlsteinNo thread could be found corresponding to that specified by the given 577285bccfSAlfred Perlsteinthread ID. 587285bccfSAlfred Perlstein.El 597285bccfSAlfred Perlstein.Sh SEE ALSO 607285bccfSAlfred Perlstein.Xr pthread_cleanup_pop 3 , 617285bccfSAlfred Perlstein.Xr pthread_cleanup_push 3 , 627285bccfSAlfred Perlstein.Xr pthread_exit 3 , 637285bccfSAlfred Perlstein.Xr pthread_join 3 , 647285bccfSAlfred Perlstein.Xr pthread_setcancelstate 3 , 657285bccfSAlfred Perlstein.Xr pthread_setcanceltype 3 , 667285bccfSAlfred Perlstein.Xr pthread_testcancel 3 677285bccfSAlfred Perlstein.Sh STANDARDS 687285bccfSAlfred Perlstein.Fn pthread_cancel 697285bccfSAlfred Perlsteinconforms to ISO/IEC 9945-1 ANSI/IEEE 707285bccfSAlfred Perlstein.Pq Dq Tn POSIX 717285bccfSAlfred PerlsteinStd 1003.1 Second Edition 1996-07-12. 727285bccfSAlfred Perlstein.Sh AUTHORS 737285bccfSAlfred PerlsteinThis man page was written by 74ded8c91aSAlexey Zelkin.An David Leonard Aq d@openbsd.org 75ded8c91aSAlexey Zelkinfor the 76ded8c91aSAlexey Zelkin.Ox 77ded8c91aSAlexey Zelkinimplementation of 78ded8c91aSAlexey Zelkin.Fn pthread_cancel . 79