Base class for the ConsumerAdmin and SupplierAdmin. More...

#include <Admin.h>

Inheritance diagram for TAO_Notify_Admin:

Collaboration diagram for TAO_Notify_Admin:

Public Types
typedef CosNotifyChannelAdmin::AdminIDSeq	SEQ

typedef CosNotifyChannelAdmin::AdminIDSeq_var	SEQ_VAR

Public Member Functions
	TAO_Notify_Admin ()
	Constructor.

virtual	~TAO_Notify_Admin ()
	Destructor.

void	init (TAO_Notify::Topology_Parent *parent)
	Init.

void	insert (TAO_Notify_Proxy *proxy)
	Insert the proxy in the <proxy_container_>.

void	cleanup_proxy (TAO_Notify_Proxy *proxy, bool is_supplier, bool experienced_timeout)
	Remove type from container_ and cleanup any EC resources.

TAO_Notify_FilterAdmin &	filter_admin (void)
	Access Admin FilterAdmin.

void	filter_operator (CosNotifyChannelAdmin::InterFilterGroupOperator filter_operator)
	Set Filter operator.

CosNotifyChannelAdmin::InterFilterGroupOperator	filter_operator (void)
	Access Filter operator.

void	subscribed_types (TAO_Notify_EventTypeSeq &subscribed_types)
	Obtain the Admin's subscribed types.

TAO_Notify_EventChannel *	event_channel () const

virtual int	shutdown (void)
	Shutdown.

virtual void	save_persistent (TAO_Notify::Topology_Saver &saver)

virtual TAO_Notify::Topology_Object *	load_child (const ACE_CString &type, CORBA::Long id, const TAO_Notify::NVPList &attrs)
	Create a child of the appropriate type and return it.

virtual void	reconnect (void)

virtual void	validate ()

void	set_default (bool is_default)

bool	is_default () const

virtual void	load_attrs (const TAO_Notify::NVPList &attrs)

Public Member Functions inherited from TAO_Notify::Topology_Parent
bool	child_change (void)

Public Member Functions inherited from TAO_Notify::Topology_Object
	Topology_Object ()
	The constructor.

virtual	~Topology_Object ()
	The destructor.

virtual void	initialize (Topology_Parent *topology_parent)
	Init this object with data from <rhs>.

virtual TAO_Notify_Object::ID	get_id (void) const
	Find the id associated with topology object.

void	get_id_path (IdVec &id_path) const
	Get the path of id's from the root to this object.

bool	is_changed (void) const
	Is there an unsaved change for this object or its children?

Public Member Functions inherited from TAO_Notify_Object
virtual	~TAO_Notify_Object (void)
	Destructor.

ID	id (void) const
	This Object's ID.

virtual CORBA::Object_ptr	activate (PortableServer::Servant servant)
	Activate.

virtual CORBA::Object_ptr	activate (PortableServer::Servant servant, CORBA::Long id)
	Activate with existing id.

void	deactivate (void)
	Deactivate.

bool	has_shutdown (void)
	Have we been shutdown. returns true if shutdown.

void	execute_task (TAO_Notify_Method_Request &method_request)

CORBA::Object_ptr	ref (void)
	Get CORBA Ref.

virtual void	set_qos (const CosNotification::QoSProperties &qos)
	Set the QoS Properties.

CosNotification::QoSProperties *	get_qos (void)
	Get the QoS Properties.

bool	find_qos_property_value (const char *name, CosNotification::PropertyValue &value) const

virtual TAO_Notify_Timer *	timer (void)
	Obtain the Timer manager associated with this object.

TAO_Notify_Event_Manager &	event_manager (void)
	Accessor for the Event Manager.

TAO_Notify_Worker_Task *	get_worker_task (void)
	Allow access to the underlying worker task.

Public Member Functions inherited from TAO_Notify_Refcountable
	TAO_Notify_Refcountable (void)
	Constructor.

virtual	~TAO_Notify_Refcountable ()

CORBA::ULong	_incr_refcnt (void)

CORBA::ULong	_decr_refcnt (void)

Public Member Functions inherited from TAO_Notify::Topology_Savable
virtual	~Topology_Savable (void)
	Destructor.

Protected Types
typedef TAO_Notify_Container_T < TAO_Notify_Proxy >	TAO_Notify_Proxy_Container

Protected Member Functions
void	save_attrs (TAO_Notify::NVPList &attrs)

virtual const char *	get_admin_type_name (void) const =0

TAO_Notify_Proxy_Container &	proxy_container ()

Protected Attributes
TAO_Notify_EventChannel::Ptr	ec_
	= Data Members

TAO_Notify_EventTypeSeq	subscribed_types_
	The types that we've subscribed our proxy objects with the event manager.

TAO_Notify_FilterAdmin	filter_admin_
	Filter Administration.

CosNotifyChannelAdmin::InterFilterGroupOperator	filter_operator_
	Filter operator.

bool	is_default_

Private Member Functions
void	remove (TAO_Notify_Proxy *proxy)
	Remove type from container_.

Private Attributes
ACE_Auto_Ptr < TAO_Notify_Proxy_Container >	proxy_container_
	The Proxy Container.

Friends
class	TAO_Notify_Builder

Detailed Description

Base class for the ConsumerAdmin and SupplierAdmin.

Member Typedef Documentation

typedef CosNotifyChannelAdmin::AdminIDSeq TAO_Notify_Admin::SEQ

typedef CosNotifyChannelAdmin::AdminIDSeq_var TAO_Notify_Admin::SEQ_VAR

typedef TAO_Notify_Container_T<TAO_Notify_Proxy> TAO_Notify_Admin::TAO_Notify_Proxy_Container

protected

Constructor & Destructor Documentation

TAO_Notify_Admin::TAO_Notify_Admin ( )

Constructor.

TAO_Notify_Admin::~TAO_Notify_Admin ( )

virtual

Destructor.

Member Function Documentation

void TAO_Notify_Admin::cleanup_proxy	(	TAO_Notify_Proxy *	proxy,
		bool	is_supplier,
		bool	experienced_timeout
	)

Remove type from container_ and cleanup any EC resources.

TAO_Notify_EventChannel * TAO_Notify_Admin::event_channel ( ) const

TAO_Notify_FilterAdmin & TAO_Notify_Admin::filter_admin ( void )

Access Admin FilterAdmin.

void TAO_Notify_Admin::filter_operator ( CosNotifyChannelAdmin::InterFilterGroupOperator filter_operator )

Set Filter operator.

CosNotifyChannelAdmin::InterFilterGroupOperator TAO_Notify_Admin::filter_operator ( void )

Access Filter operator.

virtual const char* TAO_Notify_Admin::get_admin_type_name ( void ) const

protectedpure virtual

Implemented in TAO_Notify_ConsumerAdmin, and TAO_Notify_SupplierAdmin.

void TAO_Notify_Admin::init ( TAO_Notify::Topology_Parent * parent )

Init.

void TAO_Notify_Admin::insert ( TAO_Notify_Proxy * proxy )

Insert the proxy in the <proxy_container_>.

bool TAO_Notify_Admin::is_default ( void ) const

void TAO_Notify_Admin::load_attrs ( const TAO_Notify::NVPList & attrs )

virtual

Load our attributes. Each derived type should call the superclass load first before loading its own attributes.

Reimplemented from TAO_Notify_Object.

TAO_Notify::Topology_Object * TAO_Notify_Admin::load_child	(	const ACE_CString &	type,
		CORBA::Long	id,
		const TAO_Notify::NVPList &	attrs
	)

virtual

Create a child of the appropriate type and return it.

Use "type" as passed in to determine what kind of child (supporting the Topology_Object interface) to create and return. Inform it of its new ID.

Reimplemented from TAO_Notify::Topology_Object.

Reimplemented in TAO_Notify_ConsumerAdmin, and TAO_Notify_SupplierAdmin.

TAO_Notify_Admin::TAO_Notify_Proxy_Container & TAO_Notify_Admin::proxy_container ( )

protected

void TAO_Notify_Admin::reconnect ( void )

virtual

Re-establish connections that we had before a shutdown.

After a topology restore, this method is called so we can reconnect to any external objects with whom we were interacting. We should call the reconnect() method on all of our children to give them the chance to do the same.

Reimplemented from TAO_Notify::Topology_Savable.

void TAO_Notify_Admin::remove ( TAO_Notify_Proxy * proxy )

private

Remove type from container_.

void TAO_Notify_Admin::save_attrs ( TAO_Notify::NVPList & attrs )

protectedvirtual

Called by derived types to save their attributes. Each derived type should call its superclass version before saving its own attrs.

Reimplemented from TAO_Notify_Object.

void TAO_Notify_Admin::save_persistent ( TAO_Notify::Topology_Saver & saver )

virtual

Save our state to a Topology_Saver.

Use the methods of a Topology_Saver to store all information we want persisted. This function is called by our parent, which gives us a saver to use. In turn, we must call this function on all of our children. The implementation should look like: bool change = this->self_changed_; this->self_changed_ = false; this->children_changed_ = false; if (is_persistent ()) { bool want_all_children = saver.begin_object( this->id(), type, attrs, change); for all children { if (want_all_children || child.is_changed()) { child.save_persistent(saver); } } for all deleted children { saver.delete_child(child_type, child_id); } saver.end_object(this->id(), type); )

Implements TAO_Notify::Topology_Savable.

void TAO_Notify_Admin::set_default ( bool is_default )

int TAO_Notify_Admin::shutdown ( void )

virtual

Shutdown.

Reimplemented from TAO_Notify_Object.

void TAO_Notify_Admin::subscribed_types ( TAO_Notify_EventTypeSeq & subscribed_types )

Obtain the Admin's subscribed types.

void TAO_Notify_Admin::validate ( )

virtual

Friends And Related Function Documentation

friend class TAO_Notify_Builder

friend

Member Data Documentation

TAO_Notify_EventChannel::Ptr TAO_Notify_Admin::ec_

protected

= Data Members

The EventChannel.

TAO_Notify_FilterAdmin TAO_Notify_Admin::filter_admin_

protected

Filter Administration.

CosNotifyChannelAdmin::InterFilterGroupOperator TAO_Notify_Admin::filter_operator_

protected

Filter operator.

bool TAO_Notify_Admin::is_default_

protected

ACE_Auto_Ptr< TAO_Notify_Proxy_Container > TAO_Notify_Admin::proxy_container_

private

The Proxy Container.

TAO_Notify_EventTypeSeq TAO_Notify_Admin::subscribed_types_

protected

The types that we've subscribed our proxy objects with the event manager.

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation