Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACE_Lock Class Reference

This is the abstract base class that contains the uniform locking API that is supported by all the ACE synchronization mechanisms. More...

#include <Synch.h>

Inheritance diagram for ACE_Lock:

Inheritance graph
[legend]
List of all members.

Public Methods

 ACE_Lock (void)
 CE needs a default ctor here. More...

virtual ~ACE_Lock (void)
 Noop virtual destructor. More...

virtual int remove (void)=0
virtual int acquire (void)=0
 Block the thread until the lock is acquired. Returns -1 on failure. More...

virtual int tryacquire (void)=0
virtual int release (void)=0
 Release the lock. Returns -1 on failure. More...

virtual int acquire_read (void)=0
virtual int acquire_write (void)=0
virtual int tryacquire_read (void)=0
virtual int tryacquire_write (void)=0
virtual int tryacquire_write_upgrade (void)=0

Detailed Description

This is the abstract base class that contains the uniform locking API that is supported by all the ACE synchronization mechanisms.

This class is typically used in conjunction with the <ACE_Lock_Adapter> in order to provide a polymorphic interface to the ACE synchronization mechanisms (e.g., <ACE_Mutex>, <ACE_Semaphore>, <ACE_RW_Mutex>, etc). Note that the reason that all of ACE doesn't use polymorphic locks is that (1) they add ~20% extra overhead for virtual function calls and (2) objects with virtual functions can't be placed into shared memory.

Definition at line 44 of file Synch.h.


Constructor & Destructor Documentation

ACE_INLINE ACE_Lock::ACE_Lock void   
 

CE needs a default ctor here.

Definition at line 5 of file Synch.i.

00006 {
00007 }

ACE_Lock::~ACE_Lock void    [virtual]
 

Noop virtual destructor.

Definition at line 28 of file Synch.cpp.

00029 {
00030 }


Member Function Documentation

virtual int ACE_Lock::acquire void    [pure virtual]
 

Block the thread until the lock is acquired. Returns -1 on failure.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::acquire.

virtual int ACE_Lock::acquire_read void    [pure virtual]
 

Block until the thread acquires a read lock. If the locking mechanism doesn't support read locks then this just calls <acquire>. Returns -1 on failure.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::acquire_read.

virtual int ACE_Lock::acquire_write void    [pure virtual]
 

Block until the thread acquires a write lock. If the locking mechanism doesn't support read locks then this just calls <acquire>. Returns -1 on failure.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::acquire_write.

virtual int ACE_Lock::release void    [pure virtual]
 

Release the lock. Returns -1 on failure.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::release.

virtual int ACE_Lock::remove void    [pure virtual]
 

Explicitly destroy the lock. Note that only one thread should call this method since it doesn't protect against race conditions.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::remove.

virtual int ACE_Lock::tryacquire void    [pure virtual]
 

Conditionally acquire the lock (i.e., won't block). Returns -1 on failure. If we "failed" because someone else already had the lock, <errno> is set to <EBUSY>.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::tryacquire.

virtual int ACE_Lock::tryacquire_read void    [pure virtual]
 

Conditionally acquire a read lock. If the locking mechanism doesn't support read locks then this just calls <acquire>. Returns -1 on failure. If we "failed" because someone else already had the lock, <errno> is set to <EBUSY>.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::tryacquire_read.

virtual int ACE_Lock::tryacquire_write void    [pure virtual]
 

Conditionally acquire a write lock. If the locking mechanism doesn't support read locks then this just calls <acquire>. Returns -1 on failure. If we "failed" because someone else already had the lock, <errno> is set to <EBUSY>.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::tryacquire_write.

virtual int ACE_Lock::tryacquire_write_upgrade void    [pure virtual]
 

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.

Implemented in ACE_Adaptive_Lock.

Referenced by ACE_Adaptive_Lock::tryacquire_write_upgrade.


The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:49:23 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002