ACE/ace/Static_Object_Lock.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Static_Object_Lock.h
   6  *
   7  *  @author David L. Levine <levine@cs.wustl.edu>
   8  *  @author Matthias Kerkhoff
   9  *  @author Per Andersson
  10  */
  11 //=============================================================================
  12
  13 #ifndef ACE_STATIC_OBJECT_LOCK_H
  14 #define ACE_STATIC_OBJECT_LOCK_H
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "ace/ACE_export.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #if defined (ACE_HAS_THREADS)
  24
  25 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 class ACE_Recursive_Thread_Mutex;
  28
  29 /**
  30  * @class ACE_Static_Object_Lock
  31  *
  32  * @brief Provide an interface to access a global lock.
  33  *
  34  * This class is used to serialize the creation of static
  35  * singleton objects.  It really isn't needed any more, because
  36  * anyone can access ACE_STATIC_OBJECT_LOCK directly.  But, it
  37  * is retained for backward compatibility.
  38  */
  39 class ACE_Export ACE_Static_Object_Lock
  40 {
  41 public:
  42   /// Static lock access point.
  43   static ACE_Recursive_Thread_Mutex *instance ();
  44
  45   /// For use only by ACE_Object_Manager to clean up lock if it
  46   /// what dynamically allocated.
  47   static void cleanup_lock ();
  48 };
  49
  50 ACE_END_VERSIONED_NAMESPACE_DECL
  51
  52 #endif /* ACE_HAS_THREADS */
  53
  54 #include /**/ "ace/post.h"
  55 #endif /* ACE_STATIC_OBJECT_LOCK_H */