The Ice locator registry interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::LocatorRegistry:

Collaboration diagram for Ice::LocatorRegistry:

Public Types
using	ProxyType = LocatorRegistryPrx

Public Member Functions
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...

virtual void	setAdapterDirectProxyAsync (::std::string id, ::std::shared_ptr< ObjectPrx > proxy, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const Current &current)=0
	Set the adapter endpoints with the locator registry. More...

virtual void	setReplicatedAdapterDirectProxyAsync (::std::string adapterId, ::std::string replicaGroupId, ::std::shared_ptr< ObjectPrx > p, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const Current &current)=0
	Set the adapter endpoints with the locator registry. More...

virtual void	setServerProcessProxyAsync (::std::string id, ::std::shared_ptr< ProcessPrx > proxy, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> exception, const Current &current)=0
	Set the process proxy for a server. 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 registry interface.

This interface is used by servers to register adapter endpoints with the locator.

The LocatorRegistry 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::LocatorRegistry::ProxyType = LocatorRegistryPrx

Member Function Documentation

◆ ice_id()

virtual ::std::string Ice::LocatorRegistry::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::LocatorRegistry::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::LocatorRegistry::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::LocatorRegistry::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ setAdapterDirectProxyAsync()

virtual void Ice::LocatorRegistry::setAdapterDirectProxyAsync	(	::std::string	id,
		::std::shared_ptr< ObjectPrx >	proxy,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const Current &	current
	)

pure virtual

Set the adapter endpoints with the locator registry.

Parameters

id	The adapter id.
proxy	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

Ice::AdapterAlreadyActiveException	Raised if an adapter with the same id is already active.
Ice::AdapterNotFoundException	Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.

◆ setReplicatedAdapterDirectProxyAsync()

virtual void Ice::LocatorRegistry::setReplicatedAdapterDirectProxyAsync	(	::std::string	adapterId,
		::std::string	replicaGroupId,
		::std::shared_ptr< ObjectPrx >	p,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const Current &	current
	)

pure virtual

Set the adapter endpoints with the locator registry.

Parameters

adapterId	The adapter id.
replicaGroupId	The replica group id.
p	The adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

Ice::AdapterAlreadyActiveException	Raised if an adapter with the same id is already active.
Ice::AdapterNotFoundException	Raised if the adapter cannot be found, or if the locator only allows registered adapters to set their active proxy and the adapter is not registered with the locator.
Ice::InvalidReplicaGroupIdException	Raised if the given replica group doesn't match the one registered with the locator registry for this object adapter.

◆ setServerProcessProxyAsync()

virtual void Ice::LocatorRegistry::setServerProcessProxyAsync	(	::std::string	id,
		::std::shared_ptr< ProcessPrx >	proxy,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	exception,
		const Current &	current
	)

pure virtual

Set the process proxy for a server.

Parameters

id	The server id.
proxy	The process proxy.
response	The response callback.
exception	The exception callback.
current	The Current object for the invocation.

Exceptions

Ice::ServerNotFoundException Raised if the server cannot be found.

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

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ setAdapterDirectProxyAsync()

◆ setReplicatedAdapterDirectProxyAsync()

◆ setServerProcessProxyAsync()