The Ice locator interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::Locator:

Collaboration diagram for Ice::Locator:

Public Types
using	ProxyType = LocatorPrx

Public Member Functions
virtual void	findAdapterByIdAsync (::std::string id, ::std::function< void(const ::std::shared_ptr< ObjectPrx > &returnValue)> response, ::std::function< void(::std::exception_ptr)> exception, const Current &current) const =0
	Find an adapter by id and return a proxy that contains its endpoints. More...

virtual void	findObjectByIdAsync (Identity id, ::std::function< void(const ::std::shared_ptr< ObjectPrx > &returnValue)> response, ::std::function< void(::std::exception_ptr)> exception, const Current &current) const =0
	Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object. More...

virtual ::std::shared_ptr< LocatorRegistryPrx >	getRegistry (const Current &current) const =0
	Get the locator registry. More...

virtual ::std::string	ice_id (const Current &current) const override
	Obtains a Slice type ID representing the most-derived interface supported by this object. More...

virtual ::std::vector<::std::string >	ice_ids (const Current &current) const override
	Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...

virtual bool	ice_isA (::std::string id, const Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID. More...

Public Member Functions inherited from Ice::Object
virtual bool	ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
	Dispatches an invocation to a servant. More...

virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface. More...

virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached. More...

virtual	~Object ()=default

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

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

Detailed Description

The Ice locator interface.

This interface is used by clients to lookup adapters and objects. It is also used by servers to get the locator registry proxy.

The Locator interface is intended to be used by Ice internals and by locator implementations. Regular user code should not attempt to use any functionality of this interface directly.

Member Typedef Documentation

◆ ProxyType

using Ice::Locator::ProxyType = LocatorPrx

Member Function Documentation

◆ findAdapterByIdAsync()

virtual void Ice::Locator::findAdapterByIdAsync	(	::std::string	id,
		::std::function< void(const ::std::shared_ptr< ObjectPrx > &returnValue)>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const Current &	current
	)		const

pure virtual

Find an adapter by id and return a proxy that contains its endpoints.

Parameters

id	The adapter id.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

Ice::AdapterNotFoundException Raised if the adapter cannot be found.

◆ findObjectByIdAsync()

virtual void Ice::Locator::findObjectByIdAsync	(	Identity	id,
		::std::function< void(const ::std::shared_ptr< ObjectPrx > &returnValue)>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const Current &	current
	)		const

pure virtual

Find an object by identity and return a proxy that contains the adapter ID or endpoints which can be used to access the object.

Parameters

id	The identity.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

Ice::ObjectNotFoundException Raised if the object cannot be found.

◆ getRegistry()

virtual ::std::shared_ptr<LocatorRegistryPrx> Ice::Locator::getRegistry ( const Current & current ) const

pure virtual

Get the locator registry.

Parameters

current The Current object for the invocation.

Returns: The locator registry.

◆ ice_id()

virtual ::std::string Ice::Locator::ice_id ( const Current & current ) const

overridevirtual

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.

Reimplemented from Ice::Object.

◆ ice_ids()

virtual ::std::vector<::std::string> Ice::Locator::ice_ids ( const Current & current ) const

overridevirtual

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.

Reimplemented from Ice::Object.

◆ ice_isA()

virtual bool Ice::Locator::ice_isA	(	::std::string	id,
		const Current &	current
	)		const

overridevirtual

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()

static const ::std::string& Ice::Locator::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/cpp11/x64/Release/Ice/Locator.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ findAdapterByIdAsync()

◆ findObjectByIdAsync()

◆ getRegistry()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()