pthread_cleanup_push(3) [netbsd man page]

PTHREAD_CLEANUP(3)					   BSD Library Functions Manual 					PTHREAD_CLEANUP(3)

NAME

     pthread_cleanup_push, pthread_cleanup_pop -- add and remove cleanup functions for thread exit

LIBRARY

     POSIX Threads Library (libpthread, -lpthread)

SYNOPSIS

     #include <pthread.h>

     void
     pthread_cleanup_push(void (*cleanup_routine)(void *), void *arg);

     void
     pthread_cleanup_pop(int execute);

DESCRIPTION

     The pthread_cleanup_push() function adds cleanup_routine to the top of the stack of cleanup handlers that get called when the current thread
     exits.

     The pthread_cleanup_pop() function pops the top cleanup routine off of the current threads cleanup routine stack, and, if execute is non-
     zero, it will execute the function.

     When cleanup_routine is called, it is passed arg as its only argument.

     These functions may be implemented as macros which contain scope delimiters; therefore, there must be a matching pthread_cleanup_pop() for
     every pthread_cleanup_push() at the same level of lexical scoping.

     The effect of calling longjmp() or siglongjmp() is undefined after a call to pthread_cleanup_push() but before the matching call to
     pthread_cleanup_pop() after the jump buffer was filled.

RETURN VALUES

     Neither pthread_cleanup_push() nor pthread_cleanup_pop() returns a value.

ERRORS

     None.

SEE ALSO

     pthread_exit(3)

STANDARDS

     Both functions conform to IEEE Std 1003.1-2001 (``POSIX.1'').

BSD
								   July 9, 2010 							       BSD

pthread_cleanup_push(3C)												  pthread_cleanup_push(3C)

NAME

       pthread_cleanup_push - push a thread cancellation cleanup handler

SYNOPSIS

       cc -mt [ flag... ] file... -lpthread [ library... ]
       #include <pthread.h>

       void pthread_cleanup_push(void (*handler, void *),void *arg);

       The pthread_cleanup_push() function pushes the specified cancellation cleanup handler routine, handler, onto the cancellation cleanup stack
       of the calling thread.

       When a thread exits or is canceled and its cancellation cleanup	stack is not empty, the cleanup handlers are  invoked  with  the  argument
       arg in  last in, first out (LIFO) order from the cancellation cleanup stack.

       The pthread_cleanup_push() and pthread_cleanup_pop(3C) functions can be implemented as macros. The application must ensure that they appear
       as statements, and in pairs within the same lexical scope (that is, the pthread_cleanup_push() macro can be thought to expand  to  a  token
       list whose first token is '{' with pthread_cleanup_pop() expanding to a token list whose last token is the corresponding '}').

       The  effect of the use of return, break, continue, and goto to prematurely leave a code block described by a pair of pthread_cleanup_push()
       and pthread_cleanup_pop() function calls is undefined.

       Using longjmp() or siglongjmp() to jump into or out of a push/pop pair can cause either the matching push or the matching pop statement not
       getting executed.

       The pthread_cleanup_push() function returns no value.

       No errors are defined.

       The  pthread_cleanup_push() function will not return an error code of EINTR.

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

       longjmp(3C),  pthread_cancel(3C),  pthread_cleanup_pop(3C),  pthread_exit(3C),  pthread_join(3C),  pthread_setcancelstate(3C), pthread_set-
       canceltype(3C), pthread_testcancel(3C), attributes(5), cancellation(5), condition(5), standards(5)

       See cancellation(5) for a discussion of cancellation concepts.

								    4 Oct 2005						  pthread_cleanup_push(3C)