TopicManagerObserver Interface Reference

The topic manager observer interface used by the Ice run-time to obtain and update observers for its observeable objects. More...

#include <ArmarXCore/applications/ArmarXStorm/IceStorm/Instrumentation.ice>

Inheritance diagram for TopicManagerObserver:

Public Types
typedef TopicManagerObserverPtr	PointerType

Public Member Functions
virtual::IceStorm::Instrumentation::SubscriberObserverPtr	getSubscriberObserver (const ::std::string &, const ::std::string &, const ::Ice::ObjectPrx &, const ::IceStorm::QoS &, const ::IceStorm::TopicPrx &, ::IceStorm::Instrumentation::SubscriberState, const ::IceStorm::Instrumentation::SubscriberObserverPtr &)=0
SubscriberObserver	getSubscriberObserver (string svc, string topic, Object *prx, QoS q, IceStorm::Topic *link, SubscriberState s, SubscriberObserver old)
	This method should return an observer for the given subscriber.
virtual::IceStorm::Instrumentation::TopicObserverPtr	getTopicObserver (const ::std::string &, const ::std::string &, const ::IceStorm::Instrumentation::TopicObserverPtr &)=0
TopicObserver	getTopicObserver (string svc, string name, TopicObserver old)
	This method should return an observer for the given topic.
virtual void	setObserverUpdater (const ::IceStorm::Instrumentation::ObserverUpdaterPtr &)=0
void	setObserverUpdater (ObserverUpdater updater)
	IceStorm calls this method on initialization.
virtual	~TopicManagerObserver ()

Detailed Description

The topic manager observer interface used by the Ice run-time to obtain and update observers for its observeable objects.

This interface should be implemented by add-ins that wish to observe IceStorm objects in order to collect statistics.

Member Typedef Documentation

PointerType

typedef TopicManagerObserverPtr PointerType

Constructor & Destructor Documentation

~TopicManagerObserver()

~TopicManagerObserver ( )

virtual

Member Function Documentation

getSubscriberObserver() [1/2]

virtual::IceStorm::Instrumentation::SubscriberObserverPtr getSubscriberObserver ( const ::std::string & , const ::std::string & , const ::Ice::ObjectPrx & , const ::IceStorm::QoS & , const ::IceStorm::TopicPrx & , ::IceStorm::Instrumentation::SubscriberState , const ::IceStorm::Instrumentation::SubscriberObserverPtr &  )

pure virtual

getSubscriberObserver() [2/2]

SubscriberObserver getSubscriberObserver	(	string	svc,
		string	topic,
		Object *	prx,
		QoS	q,
		IceStorm::Topic *	link,
		SubscriberState	s,
		SubscriberObserver	old )

This method should return an observer for the given subscriber.

Parameters

topic	The name of the topic subscribed.
subscriber	The proxy of the subscriber.
qos	The QoS configured for the subscriber.
link	The proxy of the linked topic if this subscriber forwards events to a linked topic.
old	The previous observer, only set when updating an existing observer.

getTopicObserver() [1/2]

virtual::IceStorm::Instrumentation::TopicObserverPtr getTopicObserver ( const ::std::string & , const ::std::string & , const ::IceStorm::Instrumentation::TopicObserverPtr &  )

pure virtual

getTopicObserver() [2/2]

TopicObserver getTopicObserver	(	string	svc,
		string	name,
		TopicObserver	old )

This method should return an observer for the given topic.

Parameters

svc	The service name.
name	The topic name.
old	The previous observer, only set when updating an existing observer.

setObserverUpdater() [1/2]

virtual void setObserverUpdater ( const ::IceStorm::Instrumentation::ObserverUpdaterPtr & )

pure virtual

setObserverUpdater() [2/2]

void setObserverUpdater

(

ObserverUpdater

updater

)

IceStorm calls this method on initialization.

The add-in implementing this interface can use this object to get IceStorm to re-obtain observers for topics and subscribers.

Parameters

updater

The observer updater object.

---

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

• ArmarXCore/applications/ArmarXStorm/IceStorm/generated/IceStorm/Instrumentation.h
• ArmarXCore/applications/ArmarXStorm/IceStorm/Instrumentation.ice
• ArmarXCore/applications/ArmarXStorm/IceStorm/generated/Instrumentation.cpp