TAO_CosNotification  2.2.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Friends | List of all members
TAO_Notify_Admin Class Referenceabstract

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

#include <Admin.h>

Inheritance diagram for TAO_Notify_Admin:
Inheritance graph
Collaboration diagram for TAO_Notify_Admin:
Collaboration graph

Public Types

- Public Types inherited from TAO_Notify_Object
typedef CORBA::Long ID
 Id for Objects. More...
- Public Types inherited from TAO_Notify_Refcountable
< TAO_Notify_Refcountable

Public Member Functions

 TAO_Notify_Admin ()
 Constructor. More...
virtual ~TAO_Notify_Admin ()
 Destructor. More...
void init (TAO_Notify::Topology_Parent *parent)
 Init. More...
void insert (TAO_Notify_Proxy *proxy)
 Insert the proxy in the <proxy_container_>. More...
void cleanup_proxy (TAO_Notify_Proxy *proxy, bool is_supplier, bool experienced_timeout)
 Remove type from container_ and cleanup any EC resources. More...
TAO_Notify_FilterAdminfilter_admin (void)
 Access Admin FilterAdmin. More...
void filter_operator (CosNotifyChannelAdmin::InterFilterGroupOperator filter_operator)
 Set Filter operator. More...
CosNotifyChannelAdmin::InterFilterGroupOperator filter_operator (void)
 Access Filter operator. More...
void subscribed_types (TAO_Notify_EventTypeSeq &subscribed_types)
 Obtain the Admin's subscribed types. More...
TAO_Notify_EventChannelevent_channel () const
virtual int shutdown (void)
 Shutdown. More...
virtual void save_persistent (TAO_Notify::Topology_Saver &saver)
load_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 ()
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. More...
virtual ~Topology_Object ()
 The destructor. More...
virtual void initialize (Topology_Parent *topology_parent)
 Init this object with data from <rhs>. More...
virtual TAO_Notify_Object::ID get_id (void) const
 Find the id associated with topology object. 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...
virtual void set_qos (const CosNotification::QoSProperties &qos)
 Set the QoS Properties. 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 Types

typedef TAO_Notify_Container_T
< TAO_Notify_Proxy

Protected Member Functions

void save_attrs (TAO_Notify::NVPList &attrs)
virtual const char * get_admin_type_name (void) const =0
TAO_Notify_Proxy_Containerproxy_container ()
- 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)

Protected Attributes

TAO_Notify_EventChannel::Ptr ec_
 = Data Members More...
TAO_Notify_EventTypeSeq subscribed_types_
 The types that we've subscribed our proxy objects with the event manager. More...
TAO_Notify_FilterAdmin filter_admin_
 Filter Administration. More...
CosNotifyChannelAdmin::InterFilterGroupOperator filter_operator_
 Filter operator. More...
bool is_default_
- 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...

Private Member Functions

void remove (TAO_Notify_Proxy *proxy)
 Remove type from container_. More...

Private Attributes

< TAO_Notify_Proxy_Container
 The Proxy Container. More...


class TAO_Notify_Builder

Detailed Description

Base class for the ConsumerAdmin and SupplierAdmin.

Member Typedef Documentation

typedef CosNotifyChannelAdmin::AdminIDSeq_var TAO_Notify_Admin::SEQ_VAR

Constructor & Destructor Documentation

TAO_Notify_Admin::TAO_Notify_Admin ( )


TAO_Notify_Admin::~TAO_Notify_Admin ( )


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
void TAO_Notify_Admin::init ( TAO_Notify::Topology_Parent parent)


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)

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 

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 ( )
void TAO_Notify_Admin::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_Admin::remove ( TAO_Notify_Proxy proxy)

Remove type from container_.

void TAO_Notify_Admin::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_Admin::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_Admin::set_default ( bool  is_default)
int TAO_Notify_Admin::shutdown ( void  )


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

Friends And Related Function Documentation

friend class TAO_Notify_Builder

Member Data Documentation

TAO_Notify_EventChannel::Ptr TAO_Notify_Admin::ec_

= Data Members

The EventChannel.

TAO_Notify_FilterAdmin TAO_Notify_Admin::filter_admin_

Filter Administration.

CosNotifyChannelAdmin::InterFilterGroupOperator TAO_Notify_Admin::filter_operator_

Filter operator.

bool TAO_Notify_Admin::is_default_
ACE_Auto_Ptr< TAO_Notify_Proxy_Container > TAO_Notify_Admin::proxy_container_

The Proxy Container.

TAO_Notify_EventTypeSeq TAO_Notify_Admin::subscribed_types_

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

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