TAO_CosNotification  2.3.2
Public Types | Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
TAO_Notify_EventChannel Class Reference

Implementation of CosNotifyChannelAdmin::EventChannel. More...

#include <EventChannel.h>

Inheritance diagram for TAO_Notify_EventChannel:
Inheritance graph
Collaboration diagram for TAO_Notify_EventChannel:
Collaboration graph

Public Types

typedef TAO_Notify_Refcountable_Guard_T< TAO_Notify_EventChannelPtr
typedef CosNotifyChannelAdmin::ChannelIDSeq SEQ
typedef CosNotifyChannelAdmin::ChannelIDSeq_var SEQ_VAR
- Public Types inherited from TAO_Notify_Object
typedef CORBA::Long ID
 Id for Objects. More...
- Public Types inherited from TAO_Notify_Refcountable
typedef TAO_Notify_Refcountable_Guard_T< TAO_Notify_RefcountablePtr

Public Member Functions

 TAO_Notify_EventChannel (void)
 Constructor. More...
virtual ~TAO_Notify_EventChannel ()
 Destructor. More...
void init (TAO_Notify_EventChannelFactory *ecf, const CosNotification::QoSProperties &initial_qos, const CosNotification::AdminProperties &initial_admin)
 Init. More...
void init (TAO_Notify::Topology_Parent *parent)
 Init (for reload) More...
void remove (TAO_Notify_ConsumerAdmin *consumer_admin)
 Remove ConsumerAdmin from its container. More...
void remove (TAO_Notify_SupplierAdmin *supplier_admin)
 Remove SupplierAdmin from its container. More...
virtual void _add_ref (void)
 ServantBase refcount methods. More...
virtual void _remove_ref (void)
virtual void save_persistent (TAO_Notify::Topology_Saver &saver)
virtual TAO_Notify::Topology_Objectload_child (const ACE_CString &type, CORBA::Long id, const TAO_Notify::NVPList &attrs)
 Create a child of the appropriate type and return it. More...
virtual void reconnect (void)
virtual void validate ()
virtual TAO_Notify_Object::ID get_id () const
 Find the id associated with topology object. More...
TAO_Notify_ProxyConsumerfind_proxy_consumer (TAO_Notify::IdVec &id_path, size_t position)
TAO_Notify_ProxySupplierfind_proxy_supplier (TAO_Notify::IdVec &id_path, size_t position)
virtual void cleanup_proxy (CosNotifyChannelAdmin::ProxyID id, bool is_supplier, bool experienced_timeout)
virtual int shutdown (void)
 Shutdown. More...
virtual void load_attrs (const TAO_Notify::NVPList &attrs)
virtual void destroy (void)
 TAO_Notify_Container_T requires a destroy method. More...
virtual CosNotifyChannelAdmin::ConsumerAdmin_ptr get_consumeradmin (CosNotifyChannelAdmin::AdminID id)
 This is public to allow TAO_MonitorConsumerAdmin access. More...
virtual CosNotifyChannelAdmin::SupplierAdmin_ptr get_supplieradmin (CosNotifyChannelAdmin::AdminID id)
 This is public to allow TAO_MonitorSupplierAdmin access. More...
TAO_Notify_FilterFactorydefault_filter_factory_servant () const
- 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. More...
virtual ~Topology_Object ()
 The destructor. More...
virtual void initialize (Topology_Parent *topology_parent)
 Init this object with data from <rhs>. More...
void get_id_path (IdVec &id_path) const
 Get the path of id's from the root to this object. More...
bool is_changed (void) const
 Is there an unsaved change for this object or its children? More...
- Public Member Functions inherited from TAO_Notify_Object
virtual ~TAO_Notify_Object (void)
 Destructor. More...
ID id (void) const
 This Object's ID. More...
virtual CORBA::Object_ptr activate (PortableServer::Servant servant)
 Activate. More...
virtual CORBA::Object_ptr activate (PortableServer::Servant servant, CORBA::Long id)
 Activate with existing id. More...
void deactivate (void)
 Deactivate. More...
bool has_shutdown (void)
 Have we been shutdown. returns true if shutdown. More...
void execute_task (TAO_Notify_Method_Request &method_request)
CORBA::Object_ptr ref (void)
 Get CORBA Ref. More...
CosNotification::QoSPropertiesget_qos (void)
 Get the QoS Properties. More...
bool find_qos_property_value (const char *name, CosNotification::PropertyValue &value) const
virtual TAO_Notify_Timertimer (void)
 Obtain the Timer manager associated with this object. More...
TAO_Notify_Event_Managerevent_manager (void)
 Accessor for the Event Manager. More...
TAO_Notify_Worker_Taskget_worker_task (void)
 Allow access to the underlying worker task. More...
- Public Member Functions inherited from TAO_Notify_Refcountable
 TAO_Notify_Refcountable (void)
 Constructor. More...
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. More...

Protected Member Functions

virtual ::CosNotifyChannelAdmin::EventChannelFactory_ptr MyFactory ()
 =CosNotifyChannelAdmin::EventChannel methods More...
virtual ::CosNotifyChannelAdmin::ConsumerAdmin_ptr default_consumer_admin (void)
virtual ::CosNotifyChannelAdmin::SupplierAdmin_ptr default_supplier_admin (void)
virtual ::CosNotifyFilter::FilterFactory_ptr default_filter_factory (void)
virtual ::CosNotifyChannelAdmin::ConsumerAdmin_ptr new_for_consumers (CosNotifyChannelAdmin::InterFilterGroupOperator op, CosNotifyChannelAdmin::AdminID_out id)
virtual ::CosNotifyChannelAdmin::SupplierAdmin_ptr new_for_suppliers (CosNotifyChannelAdmin::InterFilterGroupOperator op, CosNotifyChannelAdmin::AdminID_out id)
virtual ::CosNotifyChannelAdmin::AdminIDSeqget_all_consumeradmins (void)
virtual ::CosNotifyChannelAdmin::AdminIDSeqget_all_supplieradmins (void)
virtual ::CosNotification::QoSPropertiesget_qos (void)
virtual void set_qos (const CosNotification::QoSProperties &qos)
 Set the QoS Properties. More...
virtual void validate_qos (const CosNotification::QoSProperties &required_qos, CosNotification::NamedPropertyRangeSeq_out available_qos)
virtual ::CosNotification::AdminPropertiesget_admin (void)
virtual void set_admin (const CosNotification::AdminProperties &admin)
virtual ::CosEventChannelAdmin::ConsumerAdmin_ptr for_consumers (void)
virtual ::CosEventChannelAdmin::SupplierAdmin_ptr for_suppliers (void)
- Protected Member Functions inherited from TAO_Notify::Topology_Object
virtual bool is_persistent (void) const
 Should this object be saved? More...
bool self_change (void)
 Method to report change in this object. More...
Topology_Parenttopology_parent () const
 pointer to our topological parent More...
bool send_change (void)
 Handle details of propagating change. More...
bool send_deletion_change ()
 Handle details of propagating change for a deleted object. More...
- Protected Member Functions inherited from TAO_Notify_Object
 TAO_Notify_Object (void)
 Constructor. More...
void initialize (TAO_Notify_Object *parent)
 Init this object with data from <rhs>. More...
void inherit_poas (TAO_Notify_Object &parent)
 Uses the poas from the supplied object. More...
void adopt_poa (TAO_Notify_POA_Helper *single)
 Adopts the supplied poa as all are poas. More...
void set_primary_as_proxy_poa ()
 Changes the primary poa to the current proxy poa. More...
TAO_Notify_POA_Helperproxy_poa (void)
 Accessor for the proxy_poa_. More...
TAO_Notify_POA_Helperobject_poa (void)
 Accessor for the object_poa_. More...
TAO_Notify_POA_Helperpoa (void)
 Get the POA assigned to us. More...
void set_event_manager (TAO_Notify_Event_Manager *event_manager)
void set_admin_properties (TAO_Notify_AdminProperties *admin_properties)
TAO_Notify_AdminPropertiesadmin_properties (void)
 Accessor for the Admin Properties. More...
virtual void qos_changed (const TAO_Notify_QoSProperties &qos_properties)

Private Types

typedef TAO_Notify_Container_T< TAO_Notify_ConsumerAdminTAO_Notify_ConsumerAdmin_Container
typedef TAO_Notify_Container_T< TAO_Notify_SupplierAdminTAO_Notify_SupplierAdmin_Container

Private Member Functions

virtual void save_attrs (TAO_Notify::NVPList &attrs)
TAO_Notify_ConsumerAdmin_Containerca_container ()
TAO_Notify_SupplierAdmin_Containersa_container ()
virtual void release (void)
 The release method is called when the refcount reaches 0. More...

Private Attributes

TAO_Notify_EventChannelFactory::Ptr ecf_
TAO_SYNCH_MUTEX default_admin_mutex_
CosNotifyChannelAdmin::ConsumerAdmin_var default_consumer_admin_
 Default Consumer Admin. More...
CosNotifyChannelAdmin::SupplierAdmin_var default_supplier_admin_
 Default Supplier Admin. More...
ACE_Auto_Ptr< TAO_Notify_ConsumerAdmin_Containerca_container_
 ConsumerAdmin Container. More...
ACE_Auto_Ptr< TAO_Notify_SupplierAdmin_Containersa_container_
 SupplierAdmin Container. More...
CosNotifyFilter::FilterFactory_var default_filter_factory_
 The default filter factory. More...


class TAO_Notify_Builder

Additional Inherited Members

- Protected Attributes inherited from TAO_Notify::Topology_Object
bool self_changed_
 true if this object changed since last save_persistent More...
bool children_changed_
 true of any of this object's children changed since last save_persistent More...
 A safely-typed copy of parent_;. More...
- Protected Attributes inherited from TAO_Notify_Object
TAO_Notify_QoSProperties qos_properties_
 = Protected data members. More...
 The mutex to serialize access to state variables. More...

Detailed Description

Implementation of CosNotifyChannelAdmin::EventChannel.

Member Typedef Documentation

typedef CosNotifyChannelAdmin::ChannelIDSeq_var TAO_Notify_EventChannel::SEQ_VAR

Constructor & Destructor Documentation

TAO_Notify_EventChannel::TAO_Notify_EventChannel ( void  )


TAO_Notify_EventChannel::~TAO_Notify_EventChannel ( )


Member Function Documentation

void TAO_Notify_EventChannel::_add_ref ( void  )

ServantBase refcount methods.

void TAO_Notify_EventChannel::_remove_ref ( void  )
TAO_Notify_EventChannel::TAO_Notify_ConsumerAdmin_Container & TAO_Notify_EventChannel::ca_container ( )
void TAO_Notify_EventChannel::cleanup_proxy ( CosNotifyChannelAdmin::ProxyID  id,
bool  is_supplier,
bool  experienced_timeout 
CosNotifyChannelAdmin::ConsumerAdmin_ptr TAO_Notify_EventChannel::default_consumer_admin ( void  )
CosNotifyFilter::FilterFactory_ptr TAO_Notify_EventChannel::default_filter_factory ( void  )
TAO_Notify_FilterFactory * TAO_Notify_EventChannel::default_filter_factory_servant ( ) const
CosNotifyChannelAdmin::SupplierAdmin_ptr TAO_Notify_EventChannel::default_supplier_admin ( void  )
void TAO_Notify_EventChannel::destroy ( void  )

TAO_Notify_Container_T requires a destroy method.

TAO_Notify_ProxyConsumer * TAO_Notify_EventChannel::find_proxy_consumer ( TAO_Notify::IdVec id_path,
size_t  position 
TAO_Notify_ProxySupplier * TAO_Notify_EventChannel::find_proxy_supplier ( TAO_Notify::IdVec id_path,
size_t  position 
CosEventChannelAdmin::ConsumerAdmin_ptr TAO_Notify_EventChannel::for_consumers ( void  )
CosEventChannelAdmin::SupplierAdmin_ptr TAO_Notify_EventChannel::for_suppliers ( void  )
CosNotification::AdminProperties * TAO_Notify_EventChannel::get_admin ( void  )
CosNotifyChannelAdmin::AdminIDSeq * TAO_Notify_EventChannel::get_all_consumeradmins ( void  )
CosNotifyChannelAdmin::AdminIDSeq * TAO_Notify_EventChannel::get_all_supplieradmins ( void  )
CosNotifyChannelAdmin::ConsumerAdmin_ptr TAO_Notify_EventChannel::get_consumeradmin ( CosNotifyChannelAdmin::AdminID  id)

This is public to allow TAO_MonitorConsumerAdmin access.

virtual TAO_Notify_Object::ID TAO_Notify_EventChannel::get_id ( void  ) const

Find the id associated with topology object.

A bit of a hack because id is unknown to Topology_Object the get_id returns the same thing as id – we just need someone to find it for us.

Reimplemented from TAO_Notify::Topology_Object.

CosNotification::QoSProperties * TAO_Notify_EventChannel::get_qos ( void  )
CosNotifyChannelAdmin::SupplierAdmin_ptr TAO_Notify_EventChannel::get_supplieradmin ( CosNotifyChannelAdmin::AdminID  id)

This is public to allow TAO_MonitorSupplierAdmin access.

void TAO_Notify_EventChannel::init ( TAO_Notify_EventChannelFactory ecf,
const CosNotification::QoSProperties initial_qos,
const CosNotification::AdminProperties initial_admin 


void TAO_Notify_EventChannel::init ( TAO_Notify::Topology_Parent parent)

Init (for reload)

void TAO_Notify_EventChannel::load_attrs ( const TAO_Notify::NVPList attrs)

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_EventChannel::load_child ( const ACE_CString type,
CORBA::Long  id,
const TAO_Notify::NVPList attrs 

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.

CosNotifyChannelAdmin::EventChannelFactory_ptr TAO_Notify_EventChannel::MyFactory ( void  )
CosNotifyChannelAdmin::ConsumerAdmin_ptr TAO_Notify_EventChannel::new_for_consumers ( CosNotifyChannelAdmin::InterFilterGroupOperator  op,
CosNotifyChannelAdmin::AdminID_out  id 
CosNotifyChannelAdmin::SupplierAdmin_ptr TAO_Notify_EventChannel::new_for_suppliers ( CosNotifyChannelAdmin::InterFilterGroupOperator  op,
CosNotifyChannelAdmin::AdminID_out  id 
void TAO_Notify_EventChannel::reconnect ( void  )

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_EventChannel::release ( void  )

The release method is called when the refcount reaches 0.

Implements TAO_Notify_Refcountable.

void TAO_Notify_EventChannel::remove ( TAO_Notify_ConsumerAdmin consumer_admin)

Remove ConsumerAdmin from its container.

void TAO_Notify_EventChannel::remove ( TAO_Notify_SupplierAdmin supplier_admin)

Remove SupplierAdmin from its container.

TAO_Notify_EventChannel::TAO_Notify_SupplierAdmin_Container & TAO_Notify_EventChannel::sa_container ( )
void TAO_Notify_EventChannel::save_attrs ( TAO_Notify::NVPList attrs)

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_EventChannel::save_persistent ( TAO_Notify::Topology_Saver saver)

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_EventChannel::set_admin ( const CosNotification::AdminProperties admin)
void TAO_Notify_EventChannel::set_qos ( const CosNotification::QoSProperties qos)

Set the QoS Properties.

Reimplemented from TAO_Notify_Object.

int TAO_Notify_EventChannel::shutdown ( void  )


Reimplemented from TAO_Notify_Object.

void TAO_Notify_EventChannel::validate ( )
void TAO_Notify_EventChannel::validate_qos ( const CosNotification::QoSProperties required_qos,
CosNotification::NamedPropertyRangeSeq_out  available_qos 

Friends And Related Function Documentation

friend class TAO_Notify_Builder

Member Data Documentation

ACE_Auto_Ptr< TAO_Notify_ConsumerAdmin_Container > TAO_Notify_EventChannel::ca_container_

ConsumerAdmin Container.

TAO_SYNCH_MUTEX TAO_Notify_EventChannel::default_admin_mutex_
CosNotifyChannelAdmin::ConsumerAdmin_var TAO_Notify_EventChannel::default_consumer_admin_

Default Consumer Admin.

CosNotifyFilter::FilterFactory_var TAO_Notify_EventChannel::default_filter_factory_

The default filter factory.

TAO_Notify_FilterFactory* TAO_Notify_EventChannel::default_filter_factory_servant_
CosNotifyChannelAdmin::SupplierAdmin_var TAO_Notify_EventChannel::default_supplier_admin_

Default Supplier Admin.

TAO_Notify_EventChannelFactory::Ptr TAO_Notify_EventChannel::ecf_

= Data Members The parent object.

ACE_Auto_Ptr< TAO_Notify_SupplierAdmin_Container > TAO_Notify_EventChannel::sa_container_

SupplierAdmin Container.

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