TAO_EC_ProxyPushConsumer_Guard Class Reference

A Guard for the ProxyPushConsumer reference count. More...

#include <EC_ProxyConsumer.h>

Collaboration diagram for TAO_EC_ProxyPushConsumer_Guard:

[legend]List of all members.

Public Member Functions
	TAO_EC_ProxyPushConsumer_Guard (ACE_Lock *lock, CORBA::ULong &refcount, TAO_EC_Event_Channel_Base *ec, TAO_EC_ProxyPushConsumer *proxy)
	Constructor.
	~TAO_EC_ProxyPushConsumer_Guard (void)
	Destructor.
int	locked (void) const
	Returns 1 if the reference count successfully acquired.
Public Attributes
TAO_EC_Supplier_Filter *	filter
Private Attributes
ACE_Lock *	lock_
	The lock used to protect the reference count.
CORBA::ULong &	refcount_
	The reference count.
TAO_EC_Event_Channel_Base *	event_channel_
	The event channel used to destroy the proxy.
TAO_EC_ProxyPushConsumer *	proxy_
	The proxy whose lifetime is controlled by the reference count.
int	locked_

---

Detailed Description

A Guard for the ProxyPushConsumer reference count.

This is a helper class used in the implementation of ProxyPushConumer. It provides a Guard mechanism to increment the reference count on the proxy and its filter, eliminating the need to hold mutexes during long operations.

Definition at line 186 of file EC_ProxyConsumer.h.

---

Constructor & Destructor Documentation

TAO_EC_ProxyPushConsumer_Guard::TAO_EC_ProxyPushConsumer_Guard	(	ACE_Lock *	lock,
		CORBA::ULong &	refcount,
		TAO_EC_Event_Channel_Base *	ec,
		TAO_EC_ProxyPushConsumer *	proxy
	)

Constructor.

Definition at line 238 of file EC_ProxyConsumer.cpp.

References TAO_EC_Supplier_Filter::_incr_refcnt(), filter, TAO_EC_ProxyPushConsumer::filter_i(), TAO_EC_ProxyPushConsumer::is_connected_i(), locked_, proxy_, and refcount_.

 :   lock_ (lock),
     refcount_ (refcount),
     event_channel_ (ec),
     proxy_ (proxy),
     locked_ (0)
{
  ACE_Guard<ACE_Lock> ace_mon (*this->lock_);
  // If the guard fails there is not much we can do, raising an
  // exception is wrong, the client has *no* way to handle that kind
  // of error.  Even worse, there is no exception to raise in that
  // case.
  // @@ Returning something won't work either, the error should be
  // logged though!

  if (proxy->is_connected_i () == 0)
    return;

  this->filter = this->proxy_->filter_i ();
  this->filter->_incr_refcnt ();

  this->locked_ = 1;
  this->refcount_++;
}

TAO_EC_ProxyPushConsumer_Guard::~TAO_EC_ProxyPushConsumer_Guard

(

void

)

Destructor.

Definition at line 267 of file EC_ProxyConsumer.cpp.

References TAO_EC_Supplier_Filter::_decr_refcnt(), filter, proxy_, refcount_, and TAO_EC_ProxyPushConsumer::refcount_zero_hook().

{
  // This access is safe because guard objects are created on the
  // stack, only one thread has access to them
  if (!this->locked_)
    return;

  {
    ACE_Guard<ACE_Lock> ace_mon (*this->lock_);
    // If the guard fails there is not much we can do, raising an
    // exception is wrong, the client has *no* way to handle that kind
    // of error.  Even worse, there is no exception to raise in that
    // case.
    // @@ Returning something won't work either, the error should be
    // logged though!

    this->filter->_decr_refcnt ();

    this->refcount_--;
    if (this->refcount_ != 0)
      return;
  }

  this->proxy_->refcount_zero_hook ();
}

---

Member Function Documentation

ACE_INLINE int TAO_EC_ProxyPushConsumer_Guard::locked

(

void

)

const

Returns 1 if the reference count successfully acquired.

Definition at line 66 of file EC_ProxyConsumer.inl.

References locked_.

Referenced by TAO_EC_ProxyPushConsumer::connected(), TAO_EC_ProxyPushConsumer::disconnected(), TAO_EC_Default_ProxyPushConsumer::push(), and TAO_EC_ProxyPushConsumer::reconnected().

{
  return this->locked_;
}

---

Member Data Documentation

TAO_EC_Event_Channel_Base* TAO_EC_ProxyPushConsumer_Guard::event_channel_ [private]

The event channel used to destroy the proxy.

Definition at line 211 of file EC_ProxyConsumer.h.

TAO_EC_Supplier_Filter* TAO_EC_ProxyPushConsumer_Guard::filter

Definition at line 201 of file EC_ProxyConsumer.h.

Referenced by TAO_EC_ProxyPushConsumer::connected(), TAO_EC_ProxyPushConsumer::disconnected(), TAO_EC_Default_ProxyPushConsumer::push(), TAO_EC_ProxyPushConsumer::reconnected(), TAO_EC_ProxyPushConsumer_Guard(), and ~TAO_EC_ProxyPushConsumer_Guard().

ACE_Lock* TAO_EC_ProxyPushConsumer_Guard::lock_ [private]

The lock used to protect the reference count.

Definition at line 205 of file EC_ProxyConsumer.h.

int TAO_EC_ProxyPushConsumer_Guard::locked_ [private]

This flag is set to 1 if the reference count was successfully acquired.

Definition at line 218 of file EC_ProxyConsumer.h.

Referenced by locked(), and TAO_EC_ProxyPushConsumer_Guard().

TAO_EC_ProxyPushConsumer* TAO_EC_ProxyPushConsumer_Guard::proxy_ [private]

The proxy whose lifetime is controlled by the reference count.

Definition at line 214 of file EC_ProxyConsumer.h.

Referenced by TAO_EC_ProxyPushConsumer_Guard(), and ~TAO_EC_ProxyPushConsumer_Guard().

CORBA::ULong& TAO_EC_ProxyPushConsumer_Guard::refcount_ [private]

The reference count.

Definition at line 208 of file EC_ProxyConsumer.h.

Referenced by TAO_EC_ProxyPushConsumer_Guard(), and ~TAO_EC_ProxyPushConsumer_Guard().

---

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

• EC_ProxyConsumer.h
• EC_ProxyConsumer.cpp
• EC_ProxyConsumer.inl

---