cleanup.h

   1 /*
   2  * cleanup.h - Cleanup and shutdown framework.
   3  *
   4  * Jonathan McDowell <noodles@earth.li>
   5  *
   6  * Copyright 2004 Project Purple
   7  */
   8
   9 #ifndef __CLEANUP_H__
  10 #define __CLEANUP_H__
  11
  12 #include <stdbool.h>
  13
  14 /*
  15  *      trytocleanup - say we should try to cleanup.
  16  *
  17  *      This function sets the cleanup flag indicating we want to try and
  18  *      cleanup ASAP.
  19  */
  20 void trytocleanup(void);
  21
  22 /*
  23  *      cleanup - indicate if we should try to cleanup.
  24  *
  25  *      This function returns a bool which indicates if we want to cleanup and
  26  *      exit ASAP.
  27  */
  28 bool cleanup(void);
  29
  30 /*
  31  *      catchsignals - Register signal handlers for various signals.
  32  *
  33  *      This function registers a signal handler for various signals (PIPE,
  34  *      ALRM, INT, TERM, HUP) that sets the cleanup flag so we try to exit
  35  *      ASAP, but cleanly.
  36  */
  37 void catchsignals(void);
  38
  39 #endif /* __CLEANUP_H__ */