The IceGrid query interface. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::Query:

[legend]

Collaboration diagram for IceGrid::Query:

[legend]

Public Types
typedef QueryPtr	PointerType
typedef QueryPrx	ProxyType

Public Member Functions
virtual::Ice::ObjectProxySeq	findAllObjectsByType (const ::std::string &type, const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Find all the well-known objects with the given type.
virtual::Ice::ObjectProxySeq	findAllReplicas (const ::Ice::ObjectPrx &proxy, const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Find all the object replicas associated with the given proxy.
virtual::Ice::ObjectPrx	findObjectById (const ::Ice::Identity &id, const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Find a well-known object by identity.
virtual::Ice::ObjectPrx	findObjectByType (const ::std::string &type, const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Find a well-known object by type.
virtual::Ice::ObjectPrx	findObjectByTypeOnLeastLoadedNode (const ::std::string &type, LoadSample sample, const ::Ice::Current &current=::Ice::emptyCurrent) const =0
	Find a well-known object by type on the least-loaded node.
virtual const ::std::string &	ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string >	ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID.
virtual	~Query ()
Public Member Functions inherited from Ice::Object
virtual ObjectPtr	ice_clone () const
	Returns a shallow copy of the object.
virtual void	ice_collectable (bool b)
	Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released.
virtual bool	ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
	Dispatches an invocation to a servant.
virtual SlicedDataPtr	ice_getSlicedData () const
	Obtains the sliced data associated with this instance.
virtual const std::string &	ice_id (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type IDs of the interfaces supported by this object.
virtual bool	ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
	Tests whether this object supports a specific Slice interface.
virtual Int	ice_operationAttributes (const std::string &operation) const
	Returns the Freeze metadata attributes for an operation.
virtual void	ice_ping (const Current &current=Ice::emptyCurrent) const
	Tests whether this object can be reached.
virtual void	ice_postUnmarshal ()
	The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void	ice_preMarshal ()
	The Ice run time invokes this method prior to marshaling an object's data members.
virtual bool	operator< (const Object &) const
virtual bool	operator== (const Object &) 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 ()

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type.

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Member Functions inherited from Ice::Object
	Object ()
virtual	~Object ()
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

Detailed Description

The IceGrid query interface.

This interface is accessible to Ice clients who wish to look up well-known objects.

Member Typedef Documentation

◆ PointerType

typedef QueryPtr IceGrid::Query::PointerType

◆ ProxyType

typedef QueryPrx IceGrid::Query::ProxyType

Constructor & Destructor Documentation

◆ ~Query()

virtual IceGrid::Query::~Query ( )

virtual

Member Function Documentation

◆ findAllObjectsByType()

virtual::Ice::ObjectProxySeq IceGrid::Query::findAllObjectsByType	(	const ::std::string &	type,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

pure virtual

Find all the well-known objects with the given type.

Parameters

type	The object type.
current	The Current object for the invocation.

Returns: The proxies or an empty sequence, if no such objects have been found.

◆ findAllReplicas()

virtual::Ice::ObjectProxySeq IceGrid::Query::findAllReplicas	(	const ::Ice::ObjectPrx &	proxy,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

pure virtual

Find all the object replicas associated with the given proxy.

If the given proxy is not an indirect proxy from a replica group, an empty sequence is returned.

Parameters

proxy	The object proxy.
current	The Current object for the invocation.

Returns: The proxies of each object replica or an empty sequence, if the given proxy is not from a replica group.

◆ findObjectById()

virtual::Ice::ObjectPrx IceGrid::Query::findObjectById	(	const ::Ice::Identity &	id,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

pure virtual

Find a well-known object by identity.

Parameters

id	The identity.
current	The Current object for the invocation.

Returns: The proxy or null if no such object has been found.

◆ findObjectByType()

virtual::Ice::ObjectPrx IceGrid::Query::findObjectByType	(	const ::std::string &	type,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

pure virtual

Find a well-known object by type.

If there are several objects registered for the given type, the object is randomly selected.

Parameters

type	The object type.
current	The Current object for the invocation.

Returns: The proxy or null, if no such object has been found.

◆ findObjectByTypeOnLeastLoadedNode()

virtual::Ice::ObjectPrx IceGrid::Query::findObjectByTypeOnLeastLoadedNode	(	const ::std::string &	type,
		LoadSample	sample,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

pure virtual

Find a well-known object by type on the least-loaded node.

If the registry does not know which node hosts the object (for example, because the object was registered with a direct proxy), the registry assumes the object is hosted on a node that has a load average of 1.0.

Parameters

type	The object type.
sample	The sampling interval.
current	The Current object for the invocation.

Returns: The proxy or null, if no such object has been found.

◆ ice_id()

virtual const ::std::string & IceGrid::Query::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

virtual

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters

current The Current object for the invocation.

Returns: A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector< ::std::string > IceGrid::Query::ice_ids ( const ::Ice::Current & current = ::Ice::emptyCurrent ) const

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters

current The Current object for the invocation.

Returns: A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::Query::ice_isA	(	const ::std::string &	id,
		const ::Ice::Current &	current = ::Ice::emptyCurrent ) const

virtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters

id	The fully-scoped Slice type ID.
current	The Current object for the invocation.

Returns: True if this object supports the interface, false, otherwise.

◆ ice_staticId()

const ::std::string & IceGrid::Query::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

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

generated/cpp98/x64/Release/IceGrid/Registry.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~Query()

Member Function Documentation

◆ findAllObjectsByType()

◆ findAllReplicas()

◆ findObjectById()

◆ findObjectByType()

◆ findObjectByTypeOnLeastLoadedNode()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()