Ice 3.7 C++98 API Reference
Loading...
Searching...
No Matches
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:
Collaboration diagram for IceGrid::Locator:

Public Types

typedef LocatorPtr PointerType
typedef LocatorPrx ProxyType
Public Types inherited from Ice::Locator
typedef LocatorPtr PointerType
typedef LocatorPrx ProxyType

Public Member Functions

virtual QueryPrx getLocalQuery (const ::Ice::Current &current=::Ice::emptyCurrent) const =0
 Get the proxy of the query object hosted by this IceGrid registry.
virtual RegistryPrx getLocalRegistry (const ::Ice::Current &current=::Ice::emptyCurrent) const =0
 Get the proxy of the registry object hosted by this IceGrid registry.
virtual const ::std::string & ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string > ice_ids (const ::Ice::Current &current=::Ice::emptyCurrent) const
 Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool ice_isA (const ::std::string &id, const ::Ice::Current &current=::Ice::emptyCurrent) const
 Determines whether this object supports an interface with the given Slice type ID.
virtual ~Locator ()
Public Member Functions inherited from Ice::Locator
virtual void findAdapterById_async (const ::Ice::AMD_Locator_findAdapterByIdPtr &cb, const ::std::string &id, const Current &current=emptyCurrent) const =0
 Find an adapter by id and return a proxy that contains its endpoints.
virtual void findObjectById_async (const ::Ice::AMD_Locator_findObjectByIdPtr &cb, const Identity &id, const Current &current=emptyCurrent) 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.
virtual LocatorRegistryPrx getRegistry (const Current &current=emptyCurrent) const =0
 Get the locator registry.
virtual const ::std::string & ice_id (const Current &current=emptyCurrent) const
 Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string > ice_ids (const Current &current=emptyCurrent) const
 Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool ice_isA (const ::std::string &id, const Current &current=emptyCurrent) const
 Determines whether this object supports an interface with the given Slice type ID.
Public Member Functions inherited from Ice::Object
virtual ObjectPtr ice_clone () const
 Returns a shallow copy of the object.
virtual void ice_collectable (bool b)
 Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released.
virtual bool ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
 Dispatches an invocation to a servant.
virtual SlicedDataPtr ice_getSlicedData () const
 Obtains the sliced data associated with this instance.
virtual bool ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
 Tests whether this object supports a specific Slice interface.
virtual Int ice_operationAttributes (const std::string &operation) const
 Returns the Freeze metadata attributes for an operation.
virtual void ice_ping (const Current &current=Ice::emptyCurrent) const
 Tests whether this object can be reached.
virtual void ice_postUnmarshal ()
 The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void ice_preMarshal ()
 The Ice run time invokes this method prior to marshaling an object's data members.
virtual bool operator< (const Object &) const
virtual bool operator== (const Object &) const
Public Member Functions inherited from IceUtil::Shared
void __clearFlag (unsigned char flag)
virtual void __decRef ()
virtual int __getRef () const
bool __hasFlag (unsigned char flag)
virtual void __incRef ()
void __setFlag (unsigned char flag)
virtual void __setNoDelete (bool)
Sharedoperator= (const Shared &)
 Shared ()
 Shared (const Shared &)
virtual ~Shared ()

Static Public Member Functions

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

Additional Inherited Members

Static Public Attributes inherited from IceUtil::Shared
static const unsigned char NoDelete
Protected Member Functions inherited from Ice::Object
 Object ()
virtual ~Object ()
Protected Attributes inherited from IceUtil::Shared
unsigned char _flags
IceUtilInternal::Atomic _ref

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

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~Locator()

virtual IceGrid::Locator::~Locator ( )
virtual

Reimplemented from Ice::Locator.

Member Function Documentation

◆ getLocalQuery()

virtual QueryPrx IceGrid::Locator::getLocalQuery ( const ::Ice::Current & current = ::Ice::emptyCurrent) 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 RegistryPrx IceGrid::Locator::getLocalRegistry ( const ::Ice::Current & current = ::Ice::emptyCurrent) 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 const ::std::string & IceGrid::Locator::ice_id ( const ::Ice::Current & current = ::Ice::emptyCurrent) const
virtual

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 = ::Ice::emptyCurrent) const

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 ( const ::std::string & id,
const ::Ice::Current & current = ::Ice::emptyCurrent ) const
virtual

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

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: