TAO_ESF_Delayed_Operations. More...

#include <ESF_Delayed_Changes.h>

Inheritance diagram for TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >:

Collaboration diagram for TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >:

Public Types
typedef TAO_ESF_Connected_Command < TAO_ESF_Delayed_Changes < PROXY, COLLECTION, ITERATOR, ACE_SYNCH_USE >, PROXY >	Connected_Command
typedef TAO_ESF_Reconnected_Command < TAO_ESF_Delayed_Changes < PROXY, COLLECTION, ITERATOR, ACE_SYNCH_USE >, PROXY >	Reconnected_Command
typedef TAO_ESF_Disconnected_Command < TAO_ESF_Delayed_Changes < PROXY, COLLECTION, ITERATOR, ACE_SYNCH_USE >, PROXY >	Disconnected_Command
typedef TAO_ESF_Shutdown_Command < TAO_ESF_Delayed_Changes < PROXY, COLLECTION, ITERATOR, ACE_SYNCH_USE > >	Shutdown_Command
Public Member Functions
	TAO_ESF_Delayed_Changes (void)
	TAO_ESF_Delayed_Changes (const COLLECTION &collection)
int	busy (void)
int	idle (void)
int	execute_delayed_operations (void)
void	connected_i (PROXY *proxy)
void	reconnected_i (PROXY *proxy)
void	disconnected_i (PROXY *proxy)
void	shutdown_i (void)
virtual void	for_each (TAO_ESF_Worker< PROXY > *worker)
virtual void	connected (PROXY *proxy)
virtual void	reconnected (PROXY *proxy)
virtual void	disconnected (PROXY *proxy)
	Remove an element from the collection.
virtual void	shutdown (void)
	The EC is shutting down, must release all the elements.
Private Types
typedef TAO_ESF_Busy_Lock_Adapter < TAO_ESF_Delayed_Changes < PROXY, COLLECTION, ITERATOR, ACE_SYNCH_USE > >	Busy_Lock
Private Attributes
COLLECTION	collection_
Busy_Lock	lock_
ACE_SYNCH_MUTEX_T	busy_lock_
ACE_SYNCH_CONDITION_T	busy_cond_
CORBA::ULong	busy_count_
CORBA::ULong	write_delay_count_
CORBA::ULong	busy_hwm_
	Control variables for the concurrency policies.
CORBA::ULong	max_write_delay_
ACE_Unbounded_Queue < ACE_Command_Base * >	command_queue_

Detailed Description

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL>
class TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >

TAO_ESF_Delayed_Operations.

This class implements the Delayed Operations protocol to solve the concurrency challenges outlined in the documentation of TAO_ESF_Proxy_Collection. In short the class delays changes by putting them on an "operation queue", the operations are stored as command objects in this queue and executed once the system is quiescent (i.e. no threads are iterating over the collection). The algorithm implemented so far is:

If a thread is using the set then it increases the busy count, this is done by calling the busy() method. Once the thread has stopped using the collection the idle() method is invoked and the busy count is decreased. A helper class (Busy_Lock) is used to hide this protocol behind the familiar GUARD idiom.
If the busy count reaches the busy_hwm then the thread must wait until the count reaches 0 again. This can be used to control the maximum concurrency in the EC, matching it (for example) with the number of processors. Setting the concurrency to a high value (say one million) allows for an arbitrary number of threads to execute concurrently.
If a modification is posted to the collection we need to execute it at some point. Just using the busy_hwm would not work, the HWM may not be reached ever, so another form of control is needed. Instead we use another counter, that keeps track of how many threads have used the set since the modification was posted. If this number of threads reaches max_write_delay then we don't allow any more threads to go in, eventually the thread count reaches 0 and we can proceed with the operations.
There is one aspect of concurrency that can be problematic: if thread pushes events as part of an upcall then the same thread could be counted twice, we need to keep track of the threads that are dispatching events and not increase (or decrease) the reference count when a thread iterates twice over the same set. This solves the major problems, but there are other issues to be addressed: + How do we ensure that the operations are eventually executed? + How do we simplify the execution of the locking protocol for clients of this class? + How do we minimize overhead for single threaded execution? + How do we minimize the overhead for the cases where the threads dispatching events don't post changes to the collection?

Definition at line 88 of file ESF_Delayed_Changes.h.

Member Typedef Documentation

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

typedef TAO_ESF_Busy_Lock_Adapter<TAO_ESF_Delayed_Changes<PROXY,COLLECTION,ITERATOR,ACE_SYNCH_USE> > TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::Busy_Lock [private]

Definition at line 118 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

typedef TAO_ESF_Connected_Command<TAO_ESF_Delayed_Changes<PROXY,COLLECTION,ITERATOR,ACE_SYNCH_USE>,PROXY> TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::Connected_Command

Definition at line 103 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

typedef TAO_ESF_Disconnected_Command<TAO_ESF_Delayed_Changes<PROXY,COLLECTION,ITERATOR,ACE_SYNCH_USE>,PROXY> TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::Disconnected_Command

Definition at line 105 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

typedef TAO_ESF_Reconnected_Command<TAO_ESF_Delayed_Changes<PROXY,COLLECTION,ITERATOR,ACE_SYNCH_USE>,PROXY> TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::Reconnected_Command

Definition at line 104 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

typedef TAO_ESF_Shutdown_Command<TAO_ESF_Delayed_Changes<PROXY,COLLECTION,ITERATOR,ACE_SYNCH_USE> > TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::Shutdown_Command

Definition at line 106 of file ESF_Delayed_Changes.h.

Constructor & Destructor Documentation

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::TAO_ESF_Delayed_Changes ( void )

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::TAO_ESF_Delayed_Changes ( const COLLECTION & collection )

Member Function Documentation

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

int TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::busy ( void )

template<class PROXY, class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::connected ( PROXY * proxy ) [virtual]

Insert a new element into the collection. The collection assumes ownership of the element.

Implements TAO_ESF_Proxy_Collection< PROXY >.

Definition at line 112 of file ESF_Delayed_Changes.cpp.

{
  ACE_GUARD_THROW_EX (ACE_SYNCH_MUTEX_T, ace_mon, this->busy_lock_,
      CORBA::INTERNAL ());

  proxy->_incr_refcnt ();
  if (this->busy_count_ == 0)
    {
      // We can add the object immediately
      this->connected_i (proxy);
    }
  else
    {
      ACE_Command_Base* command = 0;
      ACE_NEW (command,
               Connected_Command (this,
                                  proxy));
      this->command_queue_.enqueue_tail (command);
      this->write_delay_count_++;
    }
}

template<class PROXY, class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::connected_i ( PROXY * proxy )

Definition at line 9 of file ESF_Delayed_Changes.inl.

{
  this->collection_.connected (proxy);
}

template<class PROXY, class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::disconnected ( PROXY * proxy ) [virtual]

Remove an element from the collection.

Implements TAO_ESF_Proxy_Collection< PROXY >.

Definition at line 160 of file ESF_Delayed_Changes.cpp.

{
  ACE_GUARD_THROW_EX (ACE_SYNCH_MUTEX_T, ace_mon, this->busy_lock_,
      CORBA::INTERNAL ());

  if (this->busy_count_ == 0)
    {
      // We can remove the object immediately
      this->disconnected_i (proxy);
    }
  else
    {
      ACE_Command_Base* command;
      ACE_NEW (command,
               Disconnected_Command (this,
                                     proxy));
      this->command_queue_.enqueue_tail (command);
      this->write_delay_count_++;
    }
}

template<class PROXY, class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::disconnected_i ( PROXY * proxy )

Definition at line 23 of file ESF_Delayed_Changes.inl.

{
  this->collection_.disconnected (proxy);
}

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

int TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::execute_delayed_operations ( void )

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

virtual void TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::for_each ( TAO_ESF_Worker< PROXY > * worker ) [virtual]

Iterate over the collection and invoke worker->work() for each member of the collection. This encapsulates

Implements TAO_ESF_Proxy_Collection< PROXY >.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

int TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::idle ( void )

template<class PROXY, class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::reconnected ( PROXY * proxy ) [virtual]

Insert an element into the collection. No errors can be raised if the element is already present. The collection assumes ownership, i.e. must invoke <proxy->_decr_refcnt()> if the element is already present in the collection.

Implements TAO_ESF_Proxy_Collection< PROXY >.

Definition at line 136 of file ESF_Delayed_Changes.cpp.

{
  ACE_GUARD_THROW_EX (ACE_SYNCH_MUTEX_T, ace_mon, this->busy_lock_,
      CORBA::INTERNAL ());

  proxy->_incr_refcnt ();
  if (this->busy_count_ == 0)
    {
      // We can reconnect the object immediately
      this->reconnected_i (proxy);
    }
  else
    {
      ACE_Command_Base* command;
      ACE_NEW (command,
               Reconnected_Command (this,
                                    proxy));
      this->command_queue_.enqueue_tail (command);
      this->write_delay_count_++;
    }
}

template<class PROXY, class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::reconnected_i ( PROXY * proxy )

Definition at line 16 of file ESF_Delayed_Changes.inl.

{
  this->collection_.reconnected (proxy);
}

template<class PROXY , class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::shutdown ( void ) [virtual]

The EC is shutting down, must release all the elements.

Implements TAO_ESF_Proxy_Collection< PROXY >.

Definition at line 182 of file ESF_Delayed_Changes.cpp.

{
  ACE_GUARD_THROW_EX (ACE_SYNCH_MUTEX_T, ace_mon, this->busy_lock_,
      CORBA::INTERNAL ());

  if (this->busy_count_ == 0)
    {
      // We can shutdown the object immediately
      this->shutdown_i ();
    }
  else
    {
      ACE_Command_Base* command;
      ACE_NEW (command,
               Shutdown_Command (this));
      this->command_queue_.enqueue_tail (command);
      this->write_delay_count_++;
    }
}

template<class PROXY , class C , class I , ACE_SYNCH_DECL >

void TAO_ESF_Delayed_Changes< PROXY, C, I, ACE_SYNCH_DECL >::shutdown_i ( void )

Definition at line 30 of file ESF_Delayed_Changes.inl.

{
  this->collection_.shutdown ();
}

Member Data Documentation

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

ACE_SYNCH_CONDITION_T TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::busy_cond_ [private]

Definition at line 124 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

CORBA::ULong TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::busy_count_ [private]

Definition at line 126 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

CORBA::ULong TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::busy_hwm_ [private]

Control variables for the concurrency policies.

Definition at line 131 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

ACE_SYNCH_MUTEX_T TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::busy_lock_ [private]

Definition at line 122 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

COLLECTION TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::collection_ [private]

Definition at line 116 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

ACE_Unbounded_Queue<ACE_Command_Base*> TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::command_queue_ [private]

Definition at line 134 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

Busy_Lock TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::lock_ [private]

Definition at line 120 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

CORBA::ULong TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::max_write_delay_ [private]

Definition at line 132 of file ESF_Delayed_Changes.h.

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL >

CORBA::ULong TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >::write_delay_count_ [private]

Definition at line 128 of file ESF_Delayed_Changes.h.

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

TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL > Class Template Reference

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL> class TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class PROXY, class COLLECTION, class ITERATOR, ACE_SYNCH_DECL>
class TAO_ESF_Delayed_Changes< PROXY, COLLECTION, ITERATOR, ACE_SYNCH_DECL >