Document return values
[ACE_TAO.git] / ACE / ace / RW_Mutex.inl
blob6d3566bb8d90fabed1b782aa0f912d1223024a53
1 // -*- C++ -*-
2 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
4 ACE_INLINE const ACE_rwlock_t &
5 ACE_RW_Mutex::lock () const
7 // ACE_TRACE ("ACE_RW_Mutex::lock");
8   return this->lock_;
11 ACE_INLINE int
12 ACE_RW_Mutex::remove ()
14 // ACE_TRACE ("ACE_RW_Mutex::remove");
15   int result = 0;
16   if (!this->removed_)
17     {
18       this->removed_ = true;
19       result = ACE_OS::rwlock_destroy (&this->lock_);
20     }
21   return result;
24 ACE_INLINE int
25 ACE_RW_Mutex::acquire_read ()
27 // ACE_TRACE ("ACE_RW_Mutex::acquire_read");
28   return ACE_OS::rw_rdlock (&this->lock_);
31 ACE_INLINE int
32 ACE_RW_Mutex::acquire_write ()
34 // ACE_TRACE ("ACE_RW_Mutex::acquire_write");
35   return ACE_OS::rw_wrlock (&this->lock_);
38 ACE_INLINE int
39 ACE_RW_Mutex::acquire ()
41 // ACE_TRACE ("ACE_RW_Mutex::acquire");
42   return ACE_OS::rw_wrlock (&this->lock_);
45 ACE_INLINE int
46 ACE_RW_Mutex::tryacquire_read ()
48 // ACE_TRACE ("ACE_RW_Mutex::tryacquire_read");
49   return ACE_OS::rw_tryrdlock (&this->lock_);
52 ACE_INLINE int
53 ACE_RW_Mutex::tryacquire_write ()
55 // ACE_TRACE ("ACE_RW_Mutex::tryacquire_write");
56   return ACE_OS::rw_trywrlock (&this->lock_);
59 ACE_INLINE int
60 ACE_RW_Mutex::tryacquire_write_upgrade ()
62 // ACE_TRACE ("ACE_RW_Mutex::tryacquire_write_upgrade");
63   return ACE_OS::rw_trywrlock_upgrade (&this->lock_);
66 ACE_INLINE int
67 ACE_RW_Mutex::tryacquire ()
69 // ACE_TRACE ("ACE_RW_Mutex::tryacquire");
70   return this->tryacquire_write ();
73 ACE_INLINE int
74 ACE_RW_Mutex::release ()
76 // ACE_TRACE ("ACE_RW_Mutex::release");
77   return ACE_OS::rw_unlock (&this->lock_);
80 ACE_END_VERSIONED_NAMESPACE_DECL