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

#include <Ice/Ice.h>

Inheritance diagram for Ice::Instrumentation::CommunicatorObserver:

[legend]

Collaboration diagram for Ice::Instrumentation::CommunicatorObserver:

[legend]

Public Types
typedef CommunicatorObserverPtr	PointerType

Public Member Functions
virtual ObserverPtr	getConnectionEstablishmentObserver (const ::Ice::EndpointPtr &endpt, const ::std::string &connector)=0
	This method should return an observer for the given endpoint information and connector.
virtual ConnectionObserverPtr	getConnectionObserver (const ::Ice::ConnectionInfoPtr &c, const ::Ice::EndpointPtr &e, ConnectionState s, const ConnectionObserverPtr &o)=0
	This method should return a connection observer for the given connection.
virtual DispatchObserverPtr	getDispatchObserver (const ::Ice::Current &c, ::Ice::Int size)=0
	This method should return a dispatch observer for the given dispatch.
virtual ObserverPtr	getEndpointLookupObserver (const ::Ice::EndpointPtr &endpt)=0
	This method should return an observer for the given endpoint information.
virtual InvocationObserverPtr	getInvocationObserver (const ::Ice::ObjectPrx &prx, const ::std::string &operation, const ::Ice::Context &ctx)=0
	This method should return an invocation observer for the given invocation.
virtual ThreadObserverPtr	getThreadObserver (const ::std::string &parent, const ::std::string &id, ThreadState s, const ThreadObserverPtr &o)=0
	This method should return a thread observer for the given thread.
virtual void	setObserverUpdater (const ObserverUpdaterPtr &updater)=0
	The Ice run-time calls this method when the communicator is initialized.
virtual	~CommunicatorObserver ()
Public Member Functions inherited from Ice::LocalObject
virtual bool	operator< (const LocalObject &) const
virtual bool	operator== (const LocalObject &) const
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

The communicator observer interface used by the Ice run-time to obtain and update observers for its observable objects.

This interface should be implemented by add-ins that wish to observe Ice objects in order to collect statistics. An instance of this interface can be provided to the Ice run-time through the Ice communicator initialization data.

Member Typedef Documentation

◆ PointerType

typedef CommunicatorObserverPtr Ice::Instrumentation::CommunicatorObserver::PointerType

Constructor & Destructor Documentation

◆ ~CommunicatorObserver()

virtual Ice::Instrumentation::CommunicatorObserver::~CommunicatorObserver ( )

virtual

Member Function Documentation

◆ getConnectionEstablishmentObserver()

virtual ObserverPtr Ice::Instrumentation::CommunicatorObserver::getConnectionEstablishmentObserver	(	const ::Ice::EndpointPtr &	endpt,
		const ::std::string &	connector )

pure virtual

This method should return an observer for the given endpoint information and connector.

The Ice run-time calls this method for each connection establishment attempt.

Parameters

endpt	The endpoint.
connector	The description of the connector. For IP transports, this is typically the IP address to connect to.

Returns: The observer to instrument the connection establishment.

◆ getConnectionObserver()

virtual ConnectionObserverPtr Ice::Instrumentation::CommunicatorObserver::getConnectionObserver	(	const ::Ice::ConnectionInfoPtr &	c,
		const ::Ice::EndpointPtr &	e,
		ConnectionState	s,
		const ConnectionObserverPtr &	o )

pure virtual

This method should return a connection observer for the given connection.

The Ice run-time calls this method for each new connection and for all the Ice communicator connections when ObserverUpdater#updateConnectionObservers is called.

Parameters

c	The connection information.
e	The connection endpoint.
s	The state of the connection.
o	The old connection observer if one is already set or a null reference otherwise.

Returns: The connection observer to instrument the connection.

◆ getDispatchObserver()

virtual DispatchObserverPtr Ice::Instrumentation::CommunicatorObserver::getDispatchObserver	(	const ::Ice::Current &	c,
		::Ice::Int	size )

pure virtual

This method should return a dispatch observer for the given dispatch.

The Ice run-time calls this method each time it receives an incoming invocation to be dispatched for an Ice object.

Parameters

c	The current object as provided to the Ice servant dispatching the invocation.
size	The size of the dispatch.

Returns: The dispatch observer to instrument the dispatch.

◆ getEndpointLookupObserver()

virtual ObserverPtr Ice::Instrumentation::CommunicatorObserver::getEndpointLookupObserver ( const ::Ice::EndpointPtr & endpt )

pure virtual

This method should return an observer for the given endpoint information.

The Ice run-time calls this method to resolve an endpoint and obtain the list of connectors.

For IP endpoints, this typically involves doing a DNS lookup to obtain the IP addresses associated with the DNS name.

Parameters

endpt The endpoint.

Returns: The observer to instrument the endpoint lookup.

◆ getInvocationObserver()

virtual InvocationObserverPtr Ice::Instrumentation::CommunicatorObserver::getInvocationObserver	(	const ::Ice::ObjectPrx &	prx,
		const ::std::string &	operation,
		const ::Ice::Context &	ctx )

pure virtual

This method should return an invocation observer for the given invocation.

The Ice run-time calls this method for each new invocation on a proxy.

Parameters

prx	The proxy used for the invocation.
operation	The name of the invocation.
ctx	The context specified by the user.

Returns: The invocation observer to instrument the invocation.

◆ getThreadObserver()

virtual ThreadObserverPtr Ice::Instrumentation::CommunicatorObserver::getThreadObserver	(	const ::std::string &	parent,
		const ::std::string &	id,
		ThreadState	s,
		const ThreadObserverPtr &	o )

pure virtual

This method should return a thread observer for the given thread.

The Ice run-time calls this method for each new thread and for all the Ice communicator threads when ObserverUpdater#updateThreadObservers is called.

Parameters

parent	The parent of the thread.
id	The ID of the thread to observe.
s	The state of the thread.
o	The old thread observer if one is already set or a null reference otherwise.

Returns: The thread observer to instrument the thread.

◆ setObserverUpdater()

virtual void Ice::Instrumentation::CommunicatorObserver::setObserverUpdater ( const ObserverUpdaterPtr & updater )

pure virtual

The Ice run-time calls this method when the communicator is initialized.

The add-in implementing this interface can use this object to get the Ice run-time to re-obtain observers for observed objects.

Parameters

updater The observer updater object.

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

generated/cpp98/x64/Release/Ice/Instrumentation.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

Constructor & Destructor Documentation

◆ ~CommunicatorObserver()

Member Function Documentation

◆ getConnectionEstablishmentObserver()

◆ getConnectionObserver()

◆ getDispatchObserver()

◆ getEndpointLookupObserver()

◆ getInvocationObserver()

◆ getThreadObserver()

◆ setObserverUpdater()