xref: /freebsd/share/man/man3/pthread_cleanup_push.3 (revision 1fbdc08dfe31ed5114e24f014a12eb08e371a3a6)
11fbdc08dSPoul-Henning Kamp.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
21fbdc08dSPoul-Henning Kamp.\" All rights reserved.
31fbdc08dSPoul-Henning Kamp.\"
41fbdc08dSPoul-Henning Kamp.\" Redistribution and use in source and binary forms, with or without
51fbdc08dSPoul-Henning Kamp.\" modification, are permitted provided that the following conditions
61fbdc08dSPoul-Henning Kamp.\" are met:
71fbdc08dSPoul-Henning Kamp.\" 1. Redistributions of source code must retain the above copyright
81fbdc08dSPoul-Henning Kamp.\"    notice, this list of conditions and the following disclaimer.
91fbdc08dSPoul-Henning Kamp.\" 2. Redistributions in binary form must reproduce the above copyright
101fbdc08dSPoul-Henning Kamp.\"    notice, this list of conditions and the following disclaimer in the
111fbdc08dSPoul-Henning Kamp.\"    documentation and/or other materials provided with the distribution.
121fbdc08dSPoul-Henning Kamp.\" 3. Neither the name of the author nor the names of any co-contributors
131fbdc08dSPoul-Henning Kamp.\"    may be used to endorse or promote products derived from this software
141fbdc08dSPoul-Henning Kamp.\"    without specific prior written permission.
151fbdc08dSPoul-Henning Kamp.\"
161fbdc08dSPoul-Henning Kamp.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
171fbdc08dSPoul-Henning Kamp.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
181fbdc08dSPoul-Henning Kamp.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
191fbdc08dSPoul-Henning Kamp.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
201fbdc08dSPoul-Henning Kamp.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
211fbdc08dSPoul-Henning Kamp.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
221fbdc08dSPoul-Henning Kamp.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
231fbdc08dSPoul-Henning Kamp.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
241fbdc08dSPoul-Henning Kamp.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
251fbdc08dSPoul-Henning Kamp.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
261fbdc08dSPoul-Henning Kamp.\" SUCH DAMAGE.
271fbdc08dSPoul-Henning Kamp.\"
281fbdc08dSPoul-Henning Kamp.Dd July 30, 1998
291fbdc08dSPoul-Henning Kamp.Dt PTHREAD_CLEANUP_PUSH 3
301fbdc08dSPoul-Henning Kamp.Os BSD 4
311fbdc08dSPoul-Henning Kamp.Sh NAME
321fbdc08dSPoul-Henning Kamp.Nm pthread_cleanup_push
331fbdc08dSPoul-Henning Kamp.Nd add a cleanup function for thread exit
341fbdc08dSPoul-Henning Kamp.Sh SYNOPSIS
351fbdc08dSPoul-Henning Kamp.Fd #include <pthread.h>
361fbdc08dSPoul-Henning Kamp.Ft void
371fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_push "void *(*cleanup_routine)(void *)" "void *arg"
381fbdc08dSPoul-Henning Kamp.Sh DESCRIPTION
391fbdc08dSPoul-Henning KampThe
401fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_push
411fbdc08dSPoul-Henning Kampfunction adds
421fbdc08dSPoul-Henning Kamp.Fa cleanup_routine
431fbdc08dSPoul-Henning Kampto the top of the stack of cleanup handlers that
441fbdc08dSPoul-Henning Kampget called when the current thread exits.
451fbdc08dSPoul-Henning Kamp.Pp
461fbdc08dSPoul-Henning KampWhen
471fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_push
481fbdc08dSPoul-Henning Kampis called, it is passed
491fbdc08dSPoul-Henning Kamp.Fa arg
501fbdc08dSPoul-Henning Kampas its only argument.
511fbdc08dSPoul-Henning Kamp.Sh RETURN VALUES
521fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_push
531fbdc08dSPoul-Henning Kampdoes not return any value.
541fbdc08dSPoul-Henning Kamp.Sh ERRORS
551fbdc08dSPoul-Henning KampNone
561fbdc08dSPoul-Henning Kamp.Sh SEE ALSO
571fbdc08dSPoul-Henning Kamp.Xr pthread_cleanup_pop 3 ,
581fbdc08dSPoul-Henning Kamp.Xr pthread_exit 3
591fbdc08dSPoul-Henning Kamp.Sh STANDARDS
601fbdc08dSPoul-Henning Kamp.Fn pthread_cleanup_push
611fbdc08dSPoul-Henning Kampis expected to conform to IEEE
621fbdc08dSPoul-Henning Kamp.Pq Dq Tn POSIX
631fbdc08dSPoul-Henning KampStd 1003.1c when it is published.
64