IceGrid::Query Interface Reference

The IceGrid query interface. More...

Defined in <IceGrid/Query.ice>

interface Query { ... }

Operations
idempotent Ice::ObjectProxySeq	findAllObjectsByType (string type)
	Find all the well-known objects with the given type. More...
idempotent Ice::ObjectProxySeq	findAllReplicas (Object *proxy)
	Find all the object replicas associated with the given proxy. More...
idempotent Object *	findObjectById (Ice::Identity id)
	Find a well-known object by identity. More...
idempotent Object *	findObjectByType (string type)
	Find a well-known object by type. More...
idempotent Object *	findObjectByTypeOnLeastLoadedNode (string type, LoadSample sample)
	Find a well-known object by type on the least-loaded node. More...

Detailed Description

The IceGrid query interface.

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

Operation Documentation

findAllObjectsByType()

["nonmutating","cpp:const"]

idempotent Ice::ObjectProxySeq findAllObjectsByType

(

string

type

)

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

Parameters

type	The object type.

Returns

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

findAllReplicas()

["cpp:const"]

idempotent Ice::ObjectProxySeq findAllReplicas

(

Object *

proxy

)

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.

Returns

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

findObjectById()

["nonmutating","cpp:const"]

idempotent Object* findObjectById

(

Ice::Identity

id

)

Find a well-known object by identity.

Parameters

id	The identity.

Returns

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

findObjectByType()

["nonmutating","cpp:const"]

idempotent Object* findObjectByType

(

string

type

)

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.

Returns

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

findObjectByTypeOnLeastLoadedNode()

["nonmutating","cpp:const"]

idempotent Object* findObjectByTypeOnLeastLoadedNode	(	string	type,
		LoadSample	sample
	)

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.

Returns

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

---

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

• IceGrid/Query.ice