The IceGrid query interface. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::QueryPrx:

Collaboration diagram for IceGrid::QueryPrx:

Public Member Functions
::Ice::ObjectProxySeq	findAllObjectsByType (const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find all the well-known objects with the given type. More...

::std::function< void()>	findAllObjectsByTypeAsync (const ::std::string &type, ::std::function< void(::Ice::ObjectProxySeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find all the well-known objects with the given type. More...

template<template< typename > class P = ::std::promise>
auto	findAllObjectsByTypeAsync (const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::ObjectProxySeq >>().get_future())
	Find all the well-known objects with the given type. More...

::Ice::ObjectProxySeq	findAllReplicas (const ::std::shared_ptr<::Ice::ObjectPrx > &proxy, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find all the object replicas associated with the given proxy. More...

::std::function< void()>	findAllReplicasAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &proxy, ::std::function< void(::Ice::ObjectProxySeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find all the object replicas associated with the given proxy. More...

template<template< typename > class P = ::std::promise>
auto	findAllReplicasAsync (const ::std::shared_ptr<::Ice::ObjectPrx > &proxy, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::Ice::ObjectProxySeq >>().get_future())
	Find all the object replicas associated with the given proxy. More...

::std::shared_ptr<::Ice::ObjectPrx >	findObjectById (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a well-known object by identity. More...

::std::function< void()>	findObjectByIdAsync (const ::Ice::Identity &id, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a well-known object by identity. More...

template<template< typename > class P = ::std::promise>
auto	findObjectByIdAsync (const ::Ice::Identity &id, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
	Find a well-known object by identity. More...

::std::shared_ptr<::Ice::ObjectPrx >	findObjectByType (const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a well-known object by type. More...

::std::function< void()>	findObjectByTypeAsync (const ::std::string &type, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a well-known object by type. More...

template<template< typename > class P = ::std::promise>
auto	findObjectByTypeAsync (const ::std::string &type, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
	Find a well-known object by type. More...

::std::shared_ptr<::Ice::ObjectPrx >	findObjectByTypeOnLeastLoadedNode (const ::std::string &type, LoadSample sample, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a well-known object by type on the least-loaded node. More...

::std::function< void()>	findObjectByTypeOnLeastLoadedNodeAsync (const ::std::string &type, LoadSample sample, ::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Find a well-known object by type on the least-loaded node. More...

template<template< typename > class P = ::std::promise>
auto	findObjectByTypeOnLeastLoadedNodeAsync (const ::std::string &type, LoadSample sample, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P<::std::shared_ptr<::Ice::ObjectPrx >>>().get_future())
	Find a well-known object by type on the least-loaded node. More...

Public Member Functions inherited from Ice::Proxy< QueryPrx, ::Ice::ObjectPrx >
::std::shared_ptr< QueryPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr< QueryPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< QueryPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< QueryPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< QueryPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints. More...

::std::shared_ptr< QueryPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< QueryPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr< QueryPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr< QueryPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< QueryPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr< QueryPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< QueryPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr< QueryPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection. More...

::std::shared_ptr< QueryPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< QueryPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr< QueryPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< QueryPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< QueryPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< QueryPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr< QueryPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< QueryPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints. More...

::std::shared_ptr< QueryPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface. More...

Detailed Description

The IceGrid query interface.

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

Member Function Documentation

◆ findAllObjectsByType()

::Ice::ObjectProxySeq IceGrid::QueryPrx::findAllObjectsByType	(	const ::std::string &	type,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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

Parameters

type	The object type.
context	The Context map to send with the invocation.

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

◆ findAllObjectsByTypeAsync() [1/2]

::std::function<void()> IceGrid::QueryPrx::findAllObjectsByTypeAsync	(	const ::std::string &	type,
		::std::function< void(::Ice::ObjectProxySeq)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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

Parameters

type	The object type.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ findAllObjectsByTypeAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::QueryPrx::findAllObjectsByTypeAsync	(	const ::std::string &	type,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::Ice::ObjectProxySeq>>().get_future())

inline

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

Parameters

type	The object type.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ findAllReplicas()

::Ice::ObjectProxySeq IceGrid::QueryPrx::findAllReplicas	(	const ::std::shared_ptr<::Ice::ObjectPrx > &	proxy,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
context	The Context map to send with the invocation.

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

◆ findAllReplicasAsync() [1/2]

::std::function<void()> IceGrid::QueryPrx::findAllReplicasAsync	(	const ::std::shared_ptr<::Ice::ObjectPrx > &	proxy,
		::std::function< void(::Ice::ObjectProxySeq)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ findAllReplicasAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::QueryPrx::findAllReplicasAsync	(	const ::std::shared_ptr<::Ice::ObjectPrx > &	proxy,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::Ice::ObjectProxySeq>>().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ findObjectById()

::std::shared_ptr<::Ice::ObjectPrx> IceGrid::QueryPrx::findObjectById	(	const ::Ice::Identity &	id,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Find a well-known object by identity.

Parameters

id	The identity.
context	The Context map to send with the invocation.

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

◆ findObjectByIdAsync() [1/2]

::std::function<void()> IceGrid::QueryPrx::findObjectByIdAsync	(	const ::Ice::Identity &	id,
		::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Find a well-known object by identity.

Parameters

id	The identity.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ findObjectByIdAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::QueryPrx::findObjectByIdAsync	(	const ::Ice::Identity &	id,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())

inline

Find a well-known object by identity.

Parameters

id	The identity.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ findObjectByType()

::std::shared_ptr<::Ice::ObjectPrx> IceGrid::QueryPrx::findObjectByType	(	const ::std::string &	type,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
context	The Context map to send with the invocation.

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

◆ findObjectByTypeAsync() [1/2]

::std::function<void()> IceGrid::QueryPrx::findObjectByTypeAsync	(	const ::std::string &	type,
		::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ findObjectByTypeAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::QueryPrx::findObjectByTypeAsync	(	const ::std::string &	type,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ findObjectByTypeOnLeastLoadedNode()

::std::shared_ptr<::Ice::ObjectPrx> IceGrid::QueryPrx::findObjectByTypeOnLeastLoadedNode	(	const ::std::string &	type,
		LoadSample	sample,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
context	The Context map to send with the invocation.

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

◆ findObjectByTypeOnLeastLoadedNodeAsync() [1/2]

::std::function<void()> IceGrid::QueryPrx::findObjectByTypeOnLeastLoadedNodeAsync	(	const ::std::string &	type,
		LoadSample	sample,
		::std::function< void(::std::shared_ptr<::Ice::ObjectPrx >)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ findObjectByTypeOnLeastLoadedNodeAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto IceGrid::QueryPrx::findObjectByTypeOnLeastLoadedNodeAsync	(	const ::std::string &	type,
		LoadSample	sample,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<::std::shared_ptr<::Ice::ObjectPrx>>>().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceGrid::QueryPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ findAllObjectsByType()

◆ findAllObjectsByTypeAsync() [1/2]

◆ findAllObjectsByTypeAsync() [2/2]

◆ findAllReplicas()

◆ findAllReplicasAsync() [1/2]

◆ findAllReplicasAsync() [2/2]

◆ findObjectById()

◆ findObjectByIdAsync() [1/2]

◆ findObjectByIdAsync() [2/2]

◆ findObjectByType()

◆ findObjectByTypeAsync() [1/2]

◆ findObjectByTypeAsync() [2/2]

◆ findObjectByTypeOnLeastLoadedNode()

◆ findObjectByTypeOnLeastLoadedNodeAsync() [1/2]

◆ findObjectByTypeOnLeastLoadedNodeAsync() [2/2]

◆ ice_staticId()