Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > Class Template Reference

Transparently parameterizes synchronization into basic arithmetic operations. More...

#include <Atomic_Op_T.h>

Collaboration diagram for ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Atomic_Op_Ex (ACE_LOCK &mtx)
 Initialize value_ to 0.

 ACE_Atomic_Op_Ex (ACE_LOCK &mtx, const TYPE &c)
 Initialize value_ to c.

TYPE operator++ (void)
 Atomically pre-increment value_.

TYPE operator++ (int)
 Atomically post-increment value_.

TYPE operator+= (const TYPE &rhs)
 Atomically increment value_ by rhs.

TYPE operator-- (void)
 Atomically pre-decrement value_.

TYPE operator-- (int)
 Atomically post-decrement value_.

TYPE operator-= (const TYPE &rhs)
 Atomically decrement value_ by rhs.

bool operator== (const TYPE &rhs) const
 Atomically compare value_ with rhs.

bool operator!= (const TYPE &rhs) const
 Atomically compare value_ with rhs.

bool operator>= (const TYPE &rhs) const
 Atomically check if value_ greater than or equal to rhs.

bool operator> (const TYPE &rhs) const
 Atomically check if value_ greater than rhs.

bool operator<= (const TYPE &rhs) const
 Atomically check if value_ less than or equal to rhs.

bool operator< (const TYPE &rhs) const
 Atomically check if value_ less than rhs.

ACE_Atomic_Op_Ex< ACE_LOCK,
TYPE > & 		operator= (const TYPE &rhs)
 Atomically assign rhs to value_.

ACE_Atomic_Op_Ex< ACE_LOCK,
TYPE > & 		operator= (const ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > &rhs)
 Atomically assign to value_.

TYPE value (void) const
 Explicitly return value_.

void dump (void) const
 Dump the state of an object.

 ACE_Atomic_Op_Ex (const ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > &)
 Manage copying...

ACE_LOCK & mutex (void)
TYPE & value_i (void)

Private Attributes

ACE_LOCK & mutex_
 Type of synchronization mechanism.

TYPE value_
 Current object decorated by the atomic op.

Detailed Description

template<class ACE_LOCK, class TYPE>
class ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >

Transparently parameterizes synchronization into basic arithmetic operations.

This class is described in an article in the July/August 1994 issue of the C++ Report magazine. It implements a templatized version of the Decorator pattern from the GoF book.

ACE_Atomic_Op_Ex objects must be constructed with a reference to an existing lock. A single lock can be shared between multiple ACE_Atomic_Op_Ex objects. If you do not require this ability consider using the ACE_Atomic_Op class instead, which may be able to take advantage of platform-specific optimisations to provide atomic operations without requiring a lock.

Definition at line 44 of file Atomic_Op_T.h.

Constructor & Destructor Documentation

template<class ACE_LOCK, class TYPE>
ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::ACE_Atomic_Op_Ex (  ACE_LOCK &  mtx  ) 
 

Initialize value_ to 0.

Definition at line 43 of file Atomic_Op_T.cpp. 

00044   : mutex_ (mtx),
00045     value_ (0)
00046 {
00047   // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::ACE_Atomic_Op_Ex");
00048 }

template<class ACE_LOCK, class TYPE>
ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::ACE_Atomic_Op_Ex (  ACE_LOCK &  mtx,
const TYPE &  c
) 
 

Initialize value_ to c.

Definition at line 52 of file Atomic_Op_T.cpp. 

00053   : mutex_ (mtx),
00054     value_ (c)
00055 {
00056 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::ACE_Atomic_Op_Ex");
00057 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::ACE_Atomic_Op_Ex (  const ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > &   ) 
 

Manage copying...

Definition at line 46 of file Atomic_Op_T.inl. 

00047   : mutex_ (rhs.mutex_)
00048 {
00049 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::ACE_Atomic_Op_Ex");
00050   *this = rhs; // Invoke the assignment operator.
00051 }

Member Function Documentation

template<class ACE_LOCK, class TYPE>
void ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::dump (  void   )  const
 

Dump the state of an object.

Definition at line 31 of file Atomic_Op_T.cpp.

References ACE_BEGIN_DUMP, ACE_DEBUG, ACE_END_DUMP, LM_DEBUG, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::mutex_. 

00032 {
00033 #if defined (ACE_HAS_DUMP)
00034   // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::dump");
00035   ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
00036   this->mutex_.dump ();
00037   ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
00038 #endif /* ACE_HAS_DUMP */
00039 }

template<class ACE_LOCK, class TYPE>
ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_LOCK & ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::mutex (  void   ) 
 

Returns a reference to the underlying . This makes it possible to acquire the lock explicitly, which can be useful in some cases if you instantiate the with an ACE_Recursive_Mutex or ACE_Process_Mutex.

Note:
the right name would be lock_, but HP/C++ will choke on that!

Definition at line 24 of file Atomic_Op_T.cpp.

References ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::mutex_. 

00025 {
00026   // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::mutex");
00027   return this->mutex_;
00028 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE bool ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator!= (  const TYPE &  rhs  )  const
 

Atomically compare value_ with rhs.

Definition at line 78 of file Atomic_Op_T.inl. 

00079 {
00080 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator!=");
00081   return !(*this == rhs);
00082 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator++ (  int   ) 
 

Atomically post-increment value_.

Definition at line 54 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00055 {
00056 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator++");
00057   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, this->value_);
00058   return this->value_++;
00059 }

template<class ACE_LOCK, class TYPE>
ACE_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator++ (  void   ) 
 

Atomically pre-increment value_.

Definition at line 14 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00015 {
00016 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator++");
00017   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, this->value_);
00018   return ++this->value_;
00019 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator+= (  const TYPE &  rhs  ) 
 

Atomically increment value_ by rhs.

Definition at line 22 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00023 {
00024 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator+=");
00025   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, this->value_);
00026   return this->value_ += rhs;
00027 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator-- (  int   ) 
 

Atomically post-decrement value_.

Definition at line 62 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00063 {
00064 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator--");
00065   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, this->value_);
00066   return this->value_--;
00067 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator-- (  void   ) 
 

Atomically pre-decrement value_.

Definition at line 30 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00031 {
00032 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator--");
00033   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, this->value_);
00034   return --this->value_;
00035 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator-= (  const TYPE &  rhs  ) 
 

Atomically decrement value_ by rhs.

Definition at line 38 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00039 {
00040 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator-=");
00041   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, this->value_);
00042   return this->value_ -= rhs;
00043 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE bool ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator< (  const TYPE &  rhs  )  const
 

Atomically check if value_ less than rhs.

Definition at line 109 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00110 {
00111 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator<");
00112   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, (ACE_LOCK &) this->mutex_, false);
00113   return this->value_ < rhs;
00114 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE bool ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator<= (  const TYPE &  rhs  )  const
 

Atomically check if value_ less than or equal to rhs.

Definition at line 101 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00102 {
00103 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator<=");
00104   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, (ACE_LOCK &) this->mutex_, false);
00105   return this->value_ <= rhs;
00106 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > & ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator= (  const ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > &  rhs  ) 
 

Atomically assign to value_.

Definition at line 117 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value(), and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00118 {
00119 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator=");
00120   if (&rhs == this)
00121     return *this; // Avoid deadlock...
00122   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, *this);
00123   // This will call ACE_Atomic_Op_Ex::TYPE(), which will ensure the
00124   // value of <rhs> is acquired atomically.
00125 
00126   this->value_ = rhs.value ();
00127   return *this;
00128 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE > & ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator= (  const TYPE &  rhs  ) 
 

Atomically assign rhs to value_.

Definition at line 149 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00150 {
00151 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator=");
00152   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, this->mutex_, *this);
00153   this->value_ = rhs;
00154   return *this;
00155 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE bool ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator== (  const TYPE &  rhs  )  const
 

Atomically compare value_ with rhs.

Definition at line 70 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00071 {
00072 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator==");
00073   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, (ACE_LOCK &) this->mutex_, false);
00074   return this->value_ == rhs;
00075 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE bool ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator> (  const TYPE &  rhs  )  const
 

Atomically check if value_ greater than rhs.

Definition at line 93 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00094 {
00095 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator>");
00096   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, (ACE_LOCK &) this->mutex_, false);
00097   return this->value_ > rhs;
00098 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE bool ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator>= (  const TYPE &  rhs  )  const
 

Atomically check if value_ greater than or equal to rhs.

Definition at line 85 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00086 {
00087 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::operator>=");
00088   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, (ACE_LOCK &) this->mutex_, false);
00089   return this->value_ >= rhs;
00090 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value (  void   )  const
 

Explicitly return value_.

Definition at line 131 of file Atomic_Op_T.inl.

References ACE_GUARD_RETURN, and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_.

Referenced by ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator=(). 

00132 {
00133 // ACE_TRACE ("ACE_Atomic_Op_Ex<ACE_LOCK, TYPE>::value");
00134   ACE_GUARD_RETURN (ACE_LOCK, ace_mon, (ACE_LOCK &) this->mutex_, this->value_);
00135   return this->value_;
00136 }

template<class ACE_LOCK, class TYPE>
ACE_INLINE TYPE & ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_i (  void   ) 
 

Explicitly return value_ (by reference). This gives the user full, unrestricted access to the underlying value. This method will usually be used in conjunction with explicit access to the lock. Use with care ;-)

Definition at line 139 of file Atomic_Op_T.inl.

References ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_. 

00140 {
00141   // Explicitly return <value_> (by reference).  This gives the user
00142   // full, unrestricted access to the underlying value.  This method
00143   // will usually be used in conjunction with explicit access to the
00144   // lock.  Use with care ;-)
00145   return this->value_;
00146 }

Member Data Documentation

template<class ACE_LOCK, class TYPE>
ACE_LOCK& ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::mutex_ [private]
 

Type of synchronization mechanism.

Definition at line 130 of file Atomic_Op_T.h.

Referenced by ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::dump(), and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::mutex().

template<class ACE_LOCK, class TYPE>
TYPE ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_ [private]
 

Current object decorated by the atomic op.

Definition at line 133 of file Atomic_Op_T.h.

Referenced by ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator++(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator+=(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator--(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator-=(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator<(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator<=(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator=(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator==(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator>(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::operator>=(), ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value(), and ACE_Atomic_Op_Ex< ACE_LOCK, TYPE >::value_i().

The documentation for this class was generated from the following files:
Generated on Sun Jan 27 12:54:03 2008 for ACE by doxygen 1.3.6