ACE/ace/Thread_Semaphore.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    Thread_Semaphore.h
   6  *
   7  *   Moved from Synch.h.
   8  *
   9  *  @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
  10  */
  11 //==========================================================================
  12
  13 #ifndef ACE_THREAD_SEMAPHORE_H
  14 #define ACE_THREAD_SEMAPHORE_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 #  include "ace/Null_Semaphore.h"
  25 #else /* ACE_HAS_THREADS */
  26 // ACE platform supports some form of threading.
  27
  28 #include "ace/Semaphore.h"
  29
  30 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  31
  32 /**
  33  * @class ACE_Thread_Semaphore
  34  *
  35  * @brief Wrapper for Dijkstra style general semaphores that work
  36  * only within one process.
  37  */
  38 class ACE_Export ACE_Thread_Semaphore : public ACE_Semaphore
  39 {
  40 public:
  41   /// Initialize the semaphore, with an initial value of @a count,
  42   /// maximum value of @a max, and unlocked by default.
  43   ACE_Thread_Semaphore (unsigned int count = 1, // By default make this unlocked.
  44                         const ACE_TCHAR *name = 0,
  45                         void * = 0,
  46                         int max = 0x7FFFFFFF);
  47
  48   /// Default destructor.
  49   ~ACE_Thread_Semaphore (void);
  50
  51   /// Dump the state of an object.
  52   void dump (void) const;
  53
  54   /// Declare the dynamic allocation hooks.
  55   ACE_ALLOC_HOOK_DECLARE;
  56 };
  57
  58 /*****************************************************************************/
  59
  60 template <class T> class ACE_Malloc_Lock_Adapter_T;
  61
  62 /**
  63  * @brief Template specialization of ACE_Malloc_Lock_Adapter_T for
  64  * ACE_Thread_Semaphore.
  65  *
  66  * This is needed since the ctor for ACE_Thread_Semaphore doesn't match
  67  * the standard form used by other lock strategy classes.
  68  */
  69 template<>
  70 class ACE_Export ACE_Malloc_Lock_Adapter_T<ACE_Thread_Semaphore>
  71 {
  72 public:
  73   ACE_Thread_Semaphore * operator () (const ACE_TCHAR *name);
  74 };
  75
  76 ACE_END_VERSIONED_NAMESPACE_DECL
  77
  78 #if defined (__ACE_INLINE__)
  79 #include "ace/Thread_Semaphore.inl"
  80 #endif /* __ACE_INLINE__ */
  81
  82 #endif /* !ACE_HAS_THREADS */
  83
  84 #include /**/ "ace/post.h"
  85 #endif /* ACE_THREAD_SEMAPHORE_H */