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 >:

Inheritance graph
[legend]
Collaboration diagram for ACE_Read_Guard< ACE_LOCK >:

Collaboration graph
[legend]

List of all members.

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 (void)
 Explicitly acquire the read lock.
int acquire (void)
 Explicitly acquire the read lock.
int tryacquire_read (void)
 Conditionally acquire the read lock (i.e., won't block).
int tryacquire (void)
 Conditionally acquire the read lock (i.e., won't block).
void dump (void) const
 Dump the state of an object.


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).

Constructor & Destructor Documentation

template<class ACE_LOCK >
ACE_Read_Guard< ACE_LOCK >::ACE_Read_Guard ( ACE_LOCK &  m  )  [inline]

Implicitly and automatically acquire a read lock.

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

template<class ACE_LOCK >
int ACE_Read_Guard< ACE_LOCK >::acquire ( void   )  [inline]

Explicitly acquire the read lock.

Reimplemented from ACE_Guard< ACE_LOCK >.

template<class ACE_LOCK >
int ACE_Read_Guard< ACE_LOCK >::acquire_read ( void   )  [inline]

Explicitly acquire the read lock.

template<class ACE_LOCK >
void ACE_Read_Guard< ACE_LOCK >::dump ( void   )  const [inline]

Dump the state of an object.

Reimplemented from ACE_Guard< ACE_LOCK >.

template<class ACE_LOCK >
int ACE_Read_Guard< ACE_LOCK >::tryacquire ( void   )  [inline]

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

Reimplemented from ACE_Guard< ACE_LOCK >.

template<class ACE_LOCK >
int ACE_Read_Guard< ACE_LOCK >::tryacquire_read ( void   )  [inline]

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


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

Generated on Mon Jul 13 16:12:41 2009 for ACE by  doxygen 1.5.8