ProxyPullConsumer. More...

#include <CEC_ProxyPullConsumer.h>

Inheritance diagram for TAO_CEC_ProxyPullConsumer:

Collaboration diagram for TAO_CEC_ProxyPullConsumer:

[legend]

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 ()
	destructor...

virtual void	activate (CosEventChannelAdmin::ProxyPullConsumer_ptr &activated_proxy)
	Activate in the POA.

virtual void	deactivate ()
	Deactivate from the POA.

CORBA::Boolean	is_connected () const
	Return 0 if no supplier is connected...

CosEventComm::PullSupplier_ptr	supplier () 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 ()

CORBA::Boolean	supplier_non_existent (CORBA::Boolean_out disconnected)

virtual void	shutdown ()
	The event channel is shutting down.

CORBA::ULong	_incr_refcnt ()
	Increment and decrement the reference count.

CORBA::ULong	_decr_refcnt ()

virtual void	connect_pull_supplier (CosEventComm::PullSupplier_ptr pull_supplier)

virtual void	disconnect_pull_consumer ()

virtual PortableServer::POA_ptr	_default_POA ()

virtual void	_add_ref ()

virtual void	_remove_ref ()

Protected Member Functions
void	supplier (CosEventComm::PullSupplier_ptr supplier)

void	supplier_i (CosEventComm::PullSupplier_ptr supplier)

CORBA::Boolean	is_connected_i () const
	The private version (without locking) of is_connected().

void	cleanup_i ()
	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 management.

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 MANAGEMENT The object commits suicide when disconnect_pull_consumer() is called.

Member Typedef Documentation

◆ _ptr_type

typedef CosEventChannelAdmin::ProxyPullConsumer_ptr TAO_CEC_ProxyPullConsumer::_ptr_type

◆ _var_type

typedef CosEventChannelAdmin::ProxyPullConsumer_var TAO_CEC_ProxyPullConsumer::_var_type

Constructor & Destructor Documentation

◆ TAO_CEC_ProxyPullConsumer()

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

constructor...

◆ ~TAO_CEC_ProxyPullConsumer()

TAO_CEC_ProxyPullConsumer::~TAO_CEC_ProxyPullConsumer ( )

virtual

destructor...

Member Function Documentation

◆ _add_ref()

void TAO_CEC_ProxyPullConsumer::_add_ref ( )

virtual

◆ _decr_refcnt()

CORBA::ULong TAO_CEC_ProxyPullConsumer::_decr_refcnt ( )

◆ _default_POA()

PortableServer::POA_ptr TAO_CEC_ProxyPullConsumer::_default_POA ( )

virtual

◆ _incr_refcnt()

CORBA::ULong TAO_CEC_ProxyPullConsumer::_incr_refcnt ( )

Increment and decrement the reference count.

◆ _remove_ref()

void TAO_CEC_ProxyPullConsumer::_remove_ref ( )

virtual

◆ activate()

void TAO_CEC_ProxyPullConsumer::activate ( CosEventChannelAdmin::ProxyPullConsumer_ptr & activated_proxy )

virtual

Activate in the POA.

◆ apply_policy()

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_.

◆ cleanup_i()

void TAO_CEC_ProxyPullConsumer::cleanup_i ( )

protected

Release the supplier.

◆ connect_pull_supplier()

void TAO_CEC_ProxyPullConsumer::connect_pull_supplier ( CosEventComm::PullSupplier_ptr pull_supplier )

virtual

◆ deactivate()

void TAO_CEC_ProxyPullConsumer::deactivate ( )

virtual

Deactivate from the POA.

◆ disconnect_pull_consumer()

void TAO_CEC_ProxyPullConsumer::disconnect_pull_consumer ( )

virtual

◆ is_connected()

CORBA::Boolean TAO_CEC_ProxyPullConsumer::is_connected ( ) const

Return 0 if no supplier is connected...

◆ is_connected_i()

CORBA::Boolean TAO_CEC_ProxyPullConsumer::is_connected_i ( ) const

protected

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

◆ pull_from_supplier()

CORBA::Any * TAO_CEC_ProxyPullConsumer::pull_from_supplier ( )

◆ shutdown()

void TAO_CEC_ProxyPullConsumer::shutdown ( )

virtual

The event channel is shutting down.

◆ supplier() [1/2]

CosEventComm::PullSupplier_ptr TAO_CEC_ProxyPullConsumer::supplier ( ) const

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

◆ supplier() [2/2]

void TAO_CEC_ProxyPullConsumer::supplier ( CosEventComm::PullSupplier_ptr supplier )

protected

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

◆ supplier_i()

void TAO_CEC_ProxyPullConsumer::supplier_i ( CosEventComm::PullSupplier_ptr supplier )

protected

◆ supplier_non_existent()

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.

◆ try_pull_from_supplier()

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

◆ default_POA_

PortableServer::POA_var TAO_CEC_ProxyPullConsumer::default_POA_

private

Store the default POA.

◆ event_channel_

TAO_CEC_EventChannel* TAO_CEC_ProxyPullConsumer::event_channel_

private

The supplier admin, used for activation and memory management.

◆ lock_

ACE_Lock* TAO_CEC_ProxyPullConsumer::lock_

private

The locking strategy.

◆ nopolicy_supplier_

CosEventComm::PullSupplier_var TAO_CEC_ProxyPullConsumer::nopolicy_supplier_

private

The supplier without any policies applied.

◆ refcount_

CORBA::ULong TAO_CEC_ProxyPullConsumer::refcount_

private

The reference count.

◆ supplier_

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.

◆ timeout_

ACE_Time_Value TAO_CEC_ProxyPullConsumer::timeout_

private

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ _ptr_type

◆ _var_type

Constructor & Destructor Documentation

◆ TAO_CEC_ProxyPullConsumer()

◆ ~TAO_CEC_ProxyPullConsumer()

Member Function Documentation

◆ _add_ref()

◆ _decr_refcnt()

◆ _default_POA()

◆ _incr_refcnt()

◆ _remove_ref()

◆ activate()

◆ apply_policy()

◆ cleanup_i()

◆ connect_pull_supplier()

◆ deactivate()

◆ disconnect_pull_consumer()

◆ is_connected()

◆ is_connected_i()

◆ pull_from_supplier()

◆ shutdown()

◆ supplier() [1/2]

◆ supplier() [2/2]

◆ supplier_i()

◆ supplier_non_existent()

◆ try_pull_from_supplier()

Member Data Documentation

◆ default_POA_

◆ event_channel_

◆ lock_

◆ nopolicy_supplier_

◆ refcount_

◆ supplier_

◆ timeout_