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

ACE_Local_WLock Class Reference

Class that acquires, renews, and releases a writer lock that is local to the process. More...

#include <Local_Tokens.h>

Inheritance diagram for ACE_Local_WLock:

Inheritance graph
[legend]
Collaboration diagram for ACE_Local_WLock:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Local_WLock (const ACE_TCHAR *token_name=0, int ignore_deadlock=0, int debug=0)
 ~ACE_Local_WLock (void)
 Destructor.

void dump (void) const
 Dump the state of the class.

virtual int type (void) const
 Returns ACE_RW_Token::WLOCK.

virtual ACE_Token_Proxy * clone (void) const
 Return deep copy.


Protected Member Functions

ACE_Tokens * create_token (const ACE_TCHAR *name)
 Return a new ACE_Local_Mutex.

Detailed Description

Class that acquires, renews, and releases a writer lock that is local to the process.

This class implements the writer interface to canonical readers/writer locks. Multiple readers can hold the lock simultaneously when no writers have the lock. Alternatively, when a writer holds the lock, no other participants (readers or writers) may hold the lock. This class is a more general-purpose synchronization mechanism than SunOS 5.x WLock. For example, it implements "recursive WLock" semantics, where a thread that owns the token can reacquire it without deadlocking. In addition, threads that are blocked awaiting the token are serviced in strict FIFO order as other threads release the token (SunOS 5.x WLocks don't strictly enforce an acquisition order). The interfaces for acquire, tryacquire, renew, release, etc. are defined in ACE_Token_Proxy. The semantics for ACE_Local_WLock are that of a readers/writers lock. Acquire for this class implies a writer acquisition. That is, only one client may hold the lock for writing.

Definition at line 1081 of file Local_Tokens.h.

Constructor & Destructor Documentation

ACE_Local_WLock::ACE_Local_WLock (  const ACE_TCHAR *  token_name = 0,
int  ignore_deadlock = 0,
int  debug = 0
) 
 

Constructor.

Parameters:
token_name Uniquely id's the token.
ignore_deadlock Will allow deadlock to occur (useful for testing).
debug Prints a bunch of messages.

ACE_Local_WLock::~ACE_Local_WLock (  void   ) 
 

Destructor.

Definition at line 1582 of file Local_Tokens.cpp. 

01583 {
01584 }

Member Function Documentation

ACE_Token_Proxy * ACE_Local_WLock::clone (  void   )  const [virtual]
 

Return deep copy.

Implements ACE_Token_Proxy.

Definition at line 1603 of file Local_Tokens.cpp.

References ACE_NEW_RETURN, and ACE_Tokens::name(). 

01604 {
01605   ACE_Token_Proxy *temp = 0;
01606   ACE_NEW_RETURN (temp,
01607                   ACE_Local_WLock (token_->name (),
01608                                    ignore_deadlock_,
01609                                    debug_),
01610                   0);
01611   return temp;
01612 }

ACE_Tokens * ACE_Local_WLock::create_token (  const ACE_TCHAR *  name  )  [protected, virtual]
 

Return a new ACE_Local_Mutex.

Implements ACE_Token_Proxy.

Definition at line 1587 of file Local_Tokens.cpp.

References ACE_NEW_RETURN, and ACE_TCHAR. 

01588 {
01589   ACE_Tokens *temp = 0;
01590   ACE_NEW_RETURN (temp,
01591                   ACE_RW_Token (name),
01592                   0);
01593   return temp;
01594 }

void ACE_Local_WLock::dump (  void   )  const
 

Dump the state of the class.

Reimplemented from ACE_Token_Proxy.

int ACE_Local_WLock::type (  void   )  const [virtual]
 

Returns ACE_RW_Token::WLOCK.

Reimplemented from ACE_Token_Proxy.

Definition at line 1597 of file Local_Tokens.cpp. 

01598 {
01599   return ACE_RW_Token::WRITER;
01600 }

The documentation for this class was generated from the following files:
Generated on Thu Nov 9 11:23:46 2006 for ACE by doxygen 1.3.6