/* -*- C++ -*- */
/**
* @file ESF_Busy_Lock.h
*
* $Id$
*
* @author Carlos O'Ryan (coryan@cs.wustl.edu)
*
* http://doc.ece.uci.edu/~coryan/EC/index.html
*/
#ifndef TAO_ESF_BUSY_LOCK_H
#define TAO_ESF_BUSY_LOCK_H
#include "ace/config-all.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
/// Adapt classes that implement the "busy lock" protocol, to conform
/// to the ACE Lock interface.
/**
* The ACE Lock interface allows us to use any mutex-like object with
* the ACE synchronization components (such as guards, Lock_Adapter,
* etc.).
* One of the synchronization protocols used in the event services
* uses the following protocol:
*
* - To acquire the lock the @c busy method of the object is invoked.
*
- To release the lock the @c idle method of the object is invoked.
*
- Any changes performed while the lock is held are delayed until
* all the locks are released, i.e. the last call to @c idle
* executes the changes.
*
*/
template
class TAO_ESF_Busy_Lock_Adapter
{
public:
/// Constructor
TAO_ESF_Busy_Lock_Adapter (Adaptee* adaptee);
/**
* @name The ACE_Lock methods
*
* Check the documentation in ace/Synch.h for details.
*/
//@{
int remove (void);
int acquire (void);
int tryacquire (void);
int release (void);
int acquire_read (void);
int acquire_write (void);
int tryacquire_read (void);
int tryacquire_write (void);
//@}
private:
Adaptee* adaptee_;
};
#if defined (__ACE_INLINE__)
#include "ESF_Busy_Lock.i"
#endif /* __ACE_INLINE__ */
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
#include "ESF_Busy_Lock.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
#pragma implementation ("ESF_Busy_Lock.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
#endif /* TAO_ESF_BUSY_LOCK_H */