diff options
author | William R. Otte <wotte@dre.vanderbilt.edu> | 2006-07-24 15:50:30 +0000 |
---|---|---|
committer | William R. Otte <wotte@dre.vanderbilt.edu> | 2006-07-24 15:50:30 +0000 |
commit | c44379cc7d9c7aa113989237ab0f56db12aa5219 (patch) | |
tree | 66a84b20d47f2269d8bdc6e0323f338763424d3a /ACE/ace/Lock_Adapter_T.h | |
parent | 3aff90f4a822fcf5d902bbfbcc9fa931d6191a8c (diff) | |
download | ATCD-c44379cc7d9c7aa113989237ab0f56db12aa5219.tar.gz |
Repo restructuring
Diffstat (limited to 'ACE/ace/Lock_Adapter_T.h')
-rw-r--r-- | ACE/ace/Lock_Adapter_T.h | 123 |
1 files changed, 123 insertions, 0 deletions
diff --git a/ACE/ace/Lock_Adapter_T.h b/ACE/ace/Lock_Adapter_T.h new file mode 100644 index 00000000000..93ee250de4b --- /dev/null +++ b/ACE/ace/Lock_Adapter_T.h @@ -0,0 +1,123 @@ +// -*- C++ -*- + +//========================================================================== +/** + * @file Lock_Adapter_T.h + * + * $Id$ + * + * Moved from Synch.h. + * + * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> + */ +//========================================================================== + +#ifndef ACE_LOCK_ADAPTER_T_H +#define ACE_LOCK_ADAPTER_T_H +#include /**/ "ace/pre.h" + +#include "ace/Lock.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +ACE_BEGIN_VERSIONED_NAMESPACE_DECL + +/** + * @class ACE_Lock_Adapter + * + * @brief This is an adapter that allows applications to transparently + * combine the <ACE_Lock> abstract base class (which contains + * pure virtual methods) with any of the other concrete ACE + * synchronization classes (e.g., <ACE_Mutex>, <ACE_Semaphore>, + * <ACE_RW_Mutex>, etc.). + * + * This class uses a form of the Adapter pattern. + */ +template <class ACE_LOCKING_MECHANISM> +class ACE_Lock_Adapter : public ACE_Lock +{ +public: + typedef ACE_LOCKING_MECHANISM ACE_LOCK; + + // = Initialization/Finalization methods. + + /// Constructor. All locking requests will be forwarded to <lock>. + ACE_Lock_Adapter (ACE_LOCKING_MECHANISM &lock); + + /// Constructor. Since no lock is provided by the user, one will be + /// created internally. + ACE_Lock_Adapter (void); + + /// Destructor. If <lock_> was not passed in by the user, it will be + /// deleted. + virtual ~ACE_Lock_Adapter (void); + + // = Lock accessors. + /// Block the thread until the lock is acquired. + virtual int acquire (void); + + /// Conditionally acquire the lock (i.e., won't block). + virtual int tryacquire (void); + + /// Release the lock. + virtual int release (void); + + /** + * Block until the thread acquires a read lock. If the locking + * mechanism doesn't support read locks then this just calls + * <acquire>. + */ + virtual int acquire_read (void); + + /** + * Block until the thread acquires a write lock. If the locking + * mechanism doesn't support read locks then this just calls + * <acquire>. + */ + virtual int acquire_write (void); + + /// Conditionally acquire a read lock. If the locking mechanism + /// doesn't support read locks then this just calls <acquire>. + virtual int tryacquire_read (void); + + /// Conditionally acquire a write lock. If the locking mechanism + /// doesn't support read locks then this just calls <acquire>. + virtual int tryacquire_write (void); + + /** + * Conditionally try to upgrade a lock held for read to a write lock. + * If the locking mechanism doesn't support read locks then this just + * calls <acquire>. Returns 0 on success, -1 on failure. + */ + virtual int tryacquire_write_upgrade (void); + + /// Explicitly destroy the lock. + virtual int remove (void); + +private: + /// The concrete locking mechanism that all the methods delegate to. + ACE_LOCKING_MECHANISM *lock_; + + /// This flag keep track of whether we are responsible for deleting + /// the lock + int delete_lock_; +}; + +ACE_END_VERSIONED_NAMESPACE_DECL + +#if defined (__ACE_INLINE__) +#include "ace/Lock_Adapter_T.inl" +#endif /* __ACE_INLINE__ */ + +#if defined (ACE_TEMPLATES_REQUIRE_SOURCE) +#include "ace/Lock_Adapter_T.cpp" +#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */ + +#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA) +#pragma implementation ("Lock_Adapter_T.cpp") +#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */ + +#include /**/ "ace/post.h" +#endif /* ACE_LOCK_ADAPTER_T_H */ |