ACE_Read_Guard< ACE_LOCK > Class Template Reference

This class is similar to class ACE_Guard, though it acquires/releases a read lock automatically (naturally, the <ACE_LOCK> it is instantiated with must support the appropriate API). More...

#include <Guard_T.h>

Inheritance diagram for ACE_Read_Guard< ACE_LOCK >:

Collaboration diagram for ACE_Read_Guard< ACE_LOCK >:

Public Member Functions
	ACE_Read_Guard (ACE_LOCK &m)
	Implicitly and automatically acquire a read lock.
	ACE_Read_Guard (ACE_LOCK &m, bool block)
int	acquire_read ()
	Explicitly acquire the read lock.
int	acquire ()
	Explicitly acquire the read lock.
int	tryacquire_read ()
	Conditionally acquire the read lock (i.e., won't block).
int	tryacquire ()
	Conditionally acquire the read lock (i.e., won't block).
void	dump () const
	Dump the state of an object.
Public Member Functions inherited from ACE_Guard< ACE_LOCK >
	ACE_Guard (ACE_LOCK &l)
	ACE_Guard (ACE_LOCK &l, bool block)
	ACE_Guard (ACE_LOCK &l, bool block, int become_owner)
	~ACE_Guard ()
	Implicitly release the lock.
int	acquire ()
	Explicitly acquire the lock.
int	tryacquire ()
	Conditionally acquire the lock (i.e., won't block).
int	release ()
	Explicitly release the lock, but only if it is held!
void	disown ()
bool	locked () const
int	remove ()
	Explicitly remove the lock.
void	dump () const
	Dump the state of an object.

Additional Inherited Members
Protected Member Functions inherited from ACE_Guard< ACE_LOCK >
	ACE_Guard (ACE_LOCK *lock)
	Helper, meant for subclass only.
Protected Attributes inherited from ACE_Guard< ACE_LOCK >
ACE_LOCK *	lock_
	Pointer to the ACE_LOCK we're guarding.
int	owner_
	Keeps track of whether we acquired the lock or failed.

Detailed Description

template<class ACE_LOCK>
class ACE_Read_Guard< ACE_LOCK >

This class is similar to class ACE_Guard, though it acquires/releases a read lock automatically (naturally, the <ACE_LOCK> it is instantiated with must support the appropriate API).

Warning

See important "WARNING" in comments at top of ACE_Guard.

Constructor & Destructor Documentation

ACE_Read_Guard() [1/2]

template<class ACE_LOCK>

ACE_Read_Guard< ACE_LOCK >::ACE_Read_Guard ( ACE_LOCK & m )

inline

Implicitly and automatically acquire a read lock.

ACE_Read_Guard() [2/2]

template<class ACE_LOCK>

ACE_Read_Guard< ACE_LOCK >::ACE_Read_Guard ( ACE_LOCK & m, bool block )

inline

Implicitly and automatically acquire (or try to acquire) a read lock.

Member Function Documentation

acquire()

template<class ACE_LOCK>

int ACE_Read_Guard< ACE_LOCK >::acquire ( )

inline

Explicitly acquire the read lock.

acquire_read()

template<class ACE_LOCK>

int ACE_Read_Guard< ACE_LOCK >::acquire_read ( )

inline

Explicitly acquire the read lock.

dump()

template<class ACE_LOCK>

void ACE_Read_Guard< ACE_LOCK >::dump

(

)

const

Dump the state of an object.

tryacquire()

template<class ACE_LOCK>

int ACE_Read_Guard< ACE_LOCK >::tryacquire ( )

inline

Conditionally acquire the read lock (i.e., won't block).

tryacquire_read()

template<class ACE_LOCK>

int ACE_Read_Guard< ACE_LOCK >::tryacquire_read ( )

inline

Conditionally acquire the read lock (i.e., won't block).

---

The documentation for this class was generated from the following files:

• Guard_T.h
• Guard_T.cpp
• Guard_T.inl