Ice 3.7 C++11 API Reference
Public Types | Public Member Functions | Static Public Member Functions | List of all members
IceGrid::Locator Class Referenceabstract

The IceGrid locator interface provides access to the Query and Registry object of the IceGrid registry. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::Locator:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::Locator:
Collaboration graph
[legend]

Public Types

using ProxyType = LocatorPrx
 
- Public Types inherited from Ice::Locator
using ProxyType = LocatorPrx
 

Public Member Functions

virtual ::std::shared_ptr< QueryPrxgetLocalQuery (const ::Ice::Current &current) const =0
 Get the proxy of the query object hosted by this IceGrid registry. More...
 
virtual ::std::shared_ptr< RegistryPrxgetLocalRegistry (const ::Ice::Current &current) const =0
 Get the proxy of the registry object hosted by this IceGrid registry. More...
 
virtual ::std::string ice_id (const ::Ice::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 ::Ice::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 ::Ice::Current &current) const override
 Determines whether this object supports an interface with the given Slice type ID. More...
 
- Public Member Functions inherited from Ice::Locator
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< LocatorRegistryPrxgetRegistry (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::Locator
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 IceGrid locator interface provides access to the Query and Registry object of the IceGrid registry.

See also
Query
Registry

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ getLocalQuery()

virtual ::std::shared_ptr<QueryPrx> IceGrid::Locator::getLocalQuery ( const ::Ice::Current current) const
pure virtual

Get the proxy of the query object hosted by this IceGrid registry.

Parameters
currentThe Current object for the invocation.
Returns
The proxy of the query object.

◆ getLocalRegistry()

virtual ::std::shared_ptr<RegistryPrx> IceGrid::Locator::getLocalRegistry ( const ::Ice::Current current) const
pure virtual

Get the proxy of the registry object hosted by this IceGrid registry.

Parameters
currentThe Current object for the invocation.
Returns
The proxy of the registry object.

◆ ice_id()

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

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

Parameters
currentThe Current object for the invocation.
Returns
A fully-scoped type ID.

◆ ice_ids()

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

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

Parameters
currentThe Current object for the invocation.
Returns
A list of fully-scoped type IDs.

◆ ice_isA()

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

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

Parameters
idThe fully-scoped Slice type ID.
currentThe Current object for the invocation.
Returns
True if this object supports the interface, false, otherwise.

◆ ice_staticId()

static const ::std::string& IceGrid::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: