ACE/ace/Cleanup.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file   Cleanup.h
   6  *
   7  *  @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
   8  *  @author Jesper S. M|ller<stophph@diku.dk>
   9  *  @author and a cast of thousands...
  10  */
  11 //=============================================================================
  12
  13 #ifndef ACE_CLEANUP_H
  14 # define ACE_CLEANUP_H
  15
  16 # include /**/ "ace/pre.h"
  17
  18 # include "ace/config-lite.h"
  19
  20 # if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 #  pragma once
  22 # endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #include /**/ "ace/ACE_export.h"
  25
  26 # include "ace/Intrusive_List.h"
  27 # include "ace/Intrusive_List_Node.h"
  28
  29 #if (defined (ACE_HAS_VERSIONED_NAMESPACE) && ACE_HAS_VERSIONED_NAMESPACE == 1)
  30 # include "ace/Global_Macros.h"
  31 # define ACE_CLEANUP_DESTROYER_NAME ACE_PREPROC_CONCATENATE(ACE_VERSIONED_NAMESPACE_NAME, _ace_cleanup_destroyer)
  32 #else
  33 # define ACE_CLEANUP_DESTROYER_NAME ace_cleanup_destroyer
  34 #endif  /* ACE_HAS_VERSIONED_NAMESPACE == 1 */
  35
  36 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  37
  38 /**
  39  * @class ACE_Cleanup
  40  *
  41  * @brief Base class for objects that are cleaned by ACE_Object_Manager.
  42  */
  43 class ACE_Export ACE_Cleanup
  44 {
  45 public:
  46   /// No-op constructor.
  47   ACE_Cleanup ();
  48
  49   /// Destructor.
  50   virtual ~ACE_Cleanup ();
  51
  52   /// Cleanup method that, by default, simply deletes itself.
  53   virtual void cleanup (void *param = 0);
  54 };
  55
  56 /// Adapter for cleanup, used by ACE_Object_Manager.
  57 extern "C" ACE_Export
  58 void ACE_CLEANUP_DESTROYER_NAME (ACE_Cleanup *, void *param = 0);
  59
  60 /**
  61  * @class ACE_Cleanup_Info_Node
  62  *
  63  * @brief For maintaining a list of ACE_Cleanup_Info items.
  64  *
  65  * For internal use by ACE_Object_Manager.
  66  */
  67 class ACE_Cleanup_Info_Node : public ACE_Intrusive_List_Node<ACE_Cleanup_Info_Node>
  68 {
  69 public:
  70   ACE_Cleanup_Info_Node ();
  71   ACE_Cleanup_Info_Node (void *object,
  72                          ACE_CLEANUP_FUNC cleanup_hook,
  73                          void *param,
  74                          const char *name);
  75   ~ACE_Cleanup_Info_Node ();
  76
  77   /// Equality operator.
  78   bool operator== (const ACE_Cleanup_Info_Node &o) const;
  79
  80   /// Inequality operator.
  81   bool operator!= (const ACE_Cleanup_Info_Node &o) const;
  82
  83   void* object();
  84
  85   ACE_CLEANUP_FUNC cleanup_hook ();
  86
  87   void *param ();
  88
  89   ACE_ALLOC_HOOK_DECLARE;
  90
  91 private:
  92   /// Point to object that gets passed into the <cleanup_hook_>.
  93   void *object_;
  94
  95   /// Cleanup hook that gets called back.
  96   ACE_CLEANUP_FUNC cleanup_hook_;
  97
  98   /// Parameter passed to the <cleanup_hook_>.
  99   void *param_;
 100
 101   /// Name of the cleanup object
 102   const char *name_;
 103 };
 104
 105 typedef ACE_Intrusive_List<ACE_Cleanup_Info_Node> ACE_Cleanup_Info_Node_List;
 106
 107 /**
 108  * @class ACE_OS_Exit_Info
 109  *
 110  * @brief Hold Object Manager cleanup (exit) information.
 111  *
 112  * @internal
 113  *
 114  * For internal use by the ACE library, only.
 115  */
 116 class ACE_Export ACE_OS_Exit_Info
 117 {
 118 public:
 119   /// Default constructor.
 120   ACE_OS_Exit_Info ();
 121
 122   /// Destructor.
 123   ~ACE_OS_Exit_Info ();
 124
 125   /// Use to register a cleanup hook.
 126   int at_exit_i (void *object, ACE_CLEANUP_FUNC cleanup_hook, void *param, const char* name = 0);
 127
 128   /// Look for a registered cleanup hook object.  Returns true if already
 129   /// registered, false if not.
 130   bool find (void *object);
 131
 132   /// Remove a registered cleanup hook object.  Returns true if removed
 133   /// false if not.
 134   bool remove (void *object);
 135
 136   /// Call all registered cleanup hooks, in reverse order of
 137   /// registration.
 138   void call_hooks ();
 139
 140 private:
 141   /**
 142    * Keeps track of all registered objects.
 143    */
 144   ACE_Cleanup_Info_Node_List registered_objects_;
 145 };
 146
 147 ACE_END_VERSIONED_NAMESPACE_DECL
 148
 149 # if defined (ACE_HAS_INLINED_OSCALLS)
 150 #   if defined (ACE_INLINE)
 151 #     undef ACE_INLINE
 152 #   endif /* ACE_INLINE */
 153 #   define ACE_INLINE inline
 154 #   include "ace/Cleanup.inl"
 155 # endif /* ACE_HAS_INLINED_OSCALLS */
 156
 157 # include /**/ "ace/post.h"
 158 #endif /* ACE_CLEANUP_H */