pthread_cleanup_push(3) [freebsd man page]

PTHREAD_CLEANUP_PUSH(3) 				   BSD Library Functions Manual 				   PTHREAD_CLEANUP_PUSH(3)

NAME

     pthread_cleanup_push -- add a cleanup function for thread exit

LIBRARY

     POSIX Threads Library (libpthread, -lpthread)

SYNOPSIS

     #include <pthread.h>

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

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.

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

     The pthread_cleanup_push() function is implemented as a macro that opens a new block.  Invocations of this function must appear as standalone
     statements that are paired with a later call of pthread_cleanup_pop(3) in the same lexical scope.

RETURN VALUES

     The pthread_cleanup_push() function does not return any value.

ERRORS

     None

SEE ALSO

     pthread_cleanup_pop(3), pthread_exit(3)

STANDARDS

     The pthread_cleanup_push() function conforms to ISO/IEC 9945-1:1996 (``POSIX.1'').

BSD
								 October 25, 2014							       BSD

pthread_cleanup_push(3) 				     Library Functions Manual					   pthread_cleanup_push(3)

NAME

       pthread_cleanup_push - (Macro) Establishes a cleanup handler routine to be executed when the thread exits or is canceled.

LIBRARY

       DECthreads POSIX 1003.1c Library (libpthread.so)

SYNOPSIS

       #include <pthread.h>

       int pthread_cleanup_push(
			 void	 (*routine)(void *),
			 void	 *arg);

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       IEEE Std 1003.1c-1995, POSIX System Application Program Interface

PARAMETERS

       Routine executed as the cleanup handler.  Argument passed to the cleanup routine.

DESCRIPTION

       This  routine pushes the specified routine onto the calling thread's cleanup handler stack.  The cleanup handler routine is popped from the
       stack and executed with the arg argument when any of the following actions occur: The thread calls pthread_cleanup_pop(3) and  specifies  a
       nonzero	value  for the execute argument.  The thread calls pthread_exit(3).  The thread is canceled.  An exception is raised and is caught
       when DECthreads unwinds the calling thread's stack to the lexical scope of the pthread_cleanup_push(3) and pthread_cleanup_pop(3) pair.

       This routine and pthread_cleanup_pop(3) are implemented as macros and must appear as statements and in pairs within the same lexical scope.
       You  can  think	of  the  pthread_cleanup_push(3)  macro  as  expanding	to  a  string  whose  first  character	is  a  left  brace ({) and
       pthread_cleanup_pop(3) as expanding to a string containing the corresponding right brace (}).

RETURN VALUES

       None

RELATED INFORMATION

       Functions: pthread_cancel(3), pthread_cleanup_pop(3), pthread_create(3), pthread_exit(3), thread_testcancel(3)

       Manuals: Guide to DECthreads and Programmer's Guide

       delim off

															   pthread_cleanup_push(3)