TAO_CEC_ProxyPullConsumer Class Reference

ProxyPullConsumer. More...

#include <CEC_ProxyPullConsumer.h>

Collaboration diagram for TAO_CEC_ProxyPullConsumer:

[legend]

List of all members.

Public Types
typedef CosEventChannelAdmin::ProxyPullConsumer_ptr	_ptr_type
typedef CosEventChannelAdmin::ProxyPullConsumer_var	_var_type
Public Member Functions
	TAO_CEC_ProxyPullConsumer (TAO_CEC_EventChannel *event_channel, const ACE_Time_Value &timeout)
	constructor...
virtual	~TAO_CEC_ProxyPullConsumer (void)
	destructor...
virtual void	activate (CosEventChannelAdmin::ProxyPullConsumer_ptr &activated_proxy)
	Activate in the POA.
virtual void	deactivate (void)
	Deactivate from the POA.
CORBA::Boolean	is_connected (void) const
	Return 0 if no supplier is connected...
CosEventComm::PullSupplier_ptr	supplier (void) const
CORBA::Any *	try_pull_from_supplier (CORBA::Boolean_out has_event)
	Pulls from the supplier, verifies that it is connected.
CORBA::Any *	pull_from_supplier (void)
CORBA::Boolean	supplier_non_existent (CORBA::Boolean_out disconnected)
virtual void	shutdown (void)
	The event channel is shutting down.
CORBA::ULong	_incr_refcnt (void)
	Increment and decrement the reference count.
CORBA::ULong	_decr_refcnt (void)
virtual void	connect_pull_supplier (CosEventComm::PullSupplier_ptr pull_supplier)
virtual void	disconnect_pull_consumer (void)
virtual PortableServer::POA_ptr	_default_POA (void)
virtual void	_add_ref (void)
virtual void	_remove_ref (void)
Protected Member Functions
void	supplier (CosEventComm::PullSupplier_ptr supplier)
void	supplier_i (CosEventComm::PullSupplier_ptr supplier)
CORBA::Boolean	is_connected_i (void) const
	The private version (without locking) of is_connected().
void	cleanup_i (void)
	Release the supplier.
CosEventComm::PullSupplier_ptr	apply_policy (CosEventComm::PullSupplier_ptr s)
Private Attributes
TAO_CEC_EventChannel *	event_channel_
	The supplier admin, used for activation and memory managment.
ACE_Time_Value	timeout_
ACE_Lock *	lock_
	The locking strategy.
CORBA::ULong	refcount_
	The reference count.
CosEventComm::PullSupplier_var	supplier_
CosEventComm::PullSupplier_var	nopolicy_supplier_
	The supplier without any policies applied.
PortableServer::POA_var	default_POA_
	Store the default POA.

---

Detailed Description

ProxyPullConsumer.

Implement the CosEventChannelAdmin::ProxyPullConsumer interface, remember that this class is used to communicate with a PullSupplier, so, in effect, this is the ambassador for a supplier inside the event channel. = MEMORY MANAGMENT The object commits suicide when disconnect_pull_consumer() is called.

---

Member Typedef Documentation

typedef CosEventChannelAdmin::ProxyPullConsumer_ptr TAO_CEC_ProxyPullConsumer::_ptr_type

typedef CosEventChannelAdmin::ProxyPullConsumer_var TAO_CEC_ProxyPullConsumer::_var_type

---

Constructor & Destructor Documentation

TAO_CEC_ProxyPullConsumer::TAO_CEC_ProxyPullConsumer	(	TAO_CEC_EventChannel *	event_channel,
		const ACE_Time_Value &	timeout
	)

constructor...

TAO_CEC_ProxyPullConsumer::~TAO_CEC_ProxyPullConsumer

(

void

)

[virtual]

destructor...

---

Member Function Documentation

void TAO_CEC_ProxyPullConsumer::_add_ref

(

void

)

[virtual]

CORBA::ULong TAO_CEC_ProxyPullConsumer::_decr_refcnt

(

void

)

PortableServer::POA_ptr TAO_CEC_ProxyPullConsumer::_default_POA

(

void

)

[virtual]

CORBA::ULong TAO_CEC_ProxyPullConsumer::_incr_refcnt

(

void

)

Increment and decrement the reference count.

void TAO_CEC_ProxyPullConsumer::_remove_ref

(

void

)

[virtual]

void TAO_CEC_ProxyPullConsumer::activate

(

CosEventChannelAdmin::ProxyPullConsumer_ptr &

activated_proxy

)

[virtual]

Activate in the POA.

CosEventComm::PullSupplier_ptr TAO_CEC_ProxyPullConsumer::apply_policy

(

CosEventComm::PullSupplier_ptr

s

)

[protected]

Assigns the parameter to both supplier_ and nopolicy_supplier_, and applies policies (when appropriate) to supplier_.

void TAO_CEC_ProxyPullConsumer::cleanup_i

(

void

)

[protected]

Release the supplier.

void TAO_CEC_ProxyPullConsumer::connect_pull_supplier

(

CosEventComm::PullSupplier_ptr

pull_supplier

)

[virtual]

void TAO_CEC_ProxyPullConsumer::deactivate

(

void

)

[virtual]

Deactivate from the POA.

void TAO_CEC_ProxyPullConsumer::disconnect_pull_consumer

(

void

)

[virtual]

CORBA::Boolean TAO_CEC_ProxyPullConsumer::is_connected

(

void

)

const [inline]

Return 0 if no supplier is connected...

CORBA::Boolean TAO_CEC_ProxyPullConsumer::is_connected_i

(

void

)

const [inline, protected]

The private version (without locking) of is_connected().

CORBA::Any * TAO_CEC_ProxyPullConsumer::pull_from_supplier

(

void

)

void TAO_CEC_ProxyPullConsumer::shutdown

(

void

)

[virtual]

The event channel is shutting down.

void TAO_CEC_ProxyPullConsumer::supplier

(

CosEventComm::PullSupplier_ptr

supplier

)

[inline, protected]

Set the supplier, used by some implementations to change the policies used when invoking operations on the supplier.

CosEventComm::PullSupplier_ptr TAO_CEC_ProxyPullConsumer::supplier

(

void

)

const [inline]

Return the consumer object reference. It returns nil() if it has not connected yet.

void TAO_CEC_ProxyPullConsumer::supplier_i

(

CosEventComm::PullSupplier_ptr

supplier

)

[inline, protected]

CORBA::Boolean TAO_CEC_ProxyPullConsumer::supplier_non_existent

(

CORBA::Boolean_out

disconnected

)

Invoke the _non_existent() pseudo-operation on the supplier. If it is disconnected then it returns true and sets the <disconnected> flag.

CORBA::Any * TAO_CEC_ProxyPullConsumer::try_pull_from_supplier

(

CORBA::Boolean_out

has_event

)

Pulls from the supplier, verifies that it is connected.

---

Member Data Documentation

PortableServer::POA_var TAO_CEC_ProxyPullConsumer::default_POA_ [private]

Store the default POA.

TAO_CEC_EventChannel* TAO_CEC_ProxyPullConsumer::event_channel_ [private]

The supplier admin, used for activation and memory managment.

ACE_Lock* TAO_CEC_ProxyPullConsumer::lock_ [private]

The locking strategy.

CosEventComm::PullSupplier_var TAO_CEC_ProxyPullConsumer::nopolicy_supplier_ [private]

The supplier without any policies applied.

CORBA::ULong TAO_CEC_ProxyPullConsumer::refcount_ [private]

The reference count.

CosEventComm::PullSupplier_var TAO_CEC_ProxyPullConsumer::supplier_ [private]

The supplier -- use apply_policy() instead of assigning directly to supplier_. This will keep supplier_ and nopolicy_supplier_ in sync.

ACE_Time_Value TAO_CEC_ProxyPullConsumer::timeout_ [private]

---

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

• CEC_ProxyPullConsumer.h
• CEC_ProxyPullConsumer.cpp
• CEC_ProxyPullConsumer.inl