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

The Ice lookup interface is implemented by Ice locator implementations and can be used by clients to find available Ice locators on the network. More...

#include <IceLocatorDiscovery/IceLocatorDiscovery.h>

Inheritance diagram for IceLocatorDiscovery::Lookup:
Inheritance graph
[legend]
Collaboration diagram for IceLocatorDiscovery::Lookup:
Collaboration graph
[legend]

Public Types

using ProxyType = LookupPrx
 

Public Member Functions

virtual void findLocator (::std::string instanceName, ::std::shared_ptr< LookupReplyPrx > reply, const ::Ice::Current &current)=0
 Find a locator proxy with the given instance name. 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::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 std::string ice_id (const Current &current) const
 Returns the Slice type ID of the most-derived interface supported by this object. More...
 
virtual std::vector< std::string > ice_ids (const Current &current) const
 Returns the Slice type IDs of the interfaces supported by this object. 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 lookup interface is implemented by Ice locator implementations and can be used by clients to find available Ice locators on the network.

Ice locator implementations provide a well-known `Ice/LocatorLookup' object accessible through UDP multicast. Clients typically make a multicast findLocator request to find the locator proxy.

See also
LookupReply

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ findLocator()

virtual void IceLocatorDiscovery::Lookup::findLocator ( ::std::string  instanceName,
::std::shared_ptr< LookupReplyPrx reply,
const ::Ice::Current current 
)
pure virtual

Find a locator proxy with the given instance name.

Parameters
instanceNameRestrict the search to Ice registries configured with the given instance name. If empty, all the available registries will reply.
replyThe reply object to use to send the reply.
currentThe Current object for the invocation.

◆ ice_id()

virtual ::std::string IceLocatorDiscovery::Lookup::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> IceLocatorDiscovery::Lookup::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 IceLocatorDiscovery::Lookup::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& IceLocatorDiscovery::Lookup::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: