The Ice locator interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::Locator:

[legend]

Collaboration diagram for Ice::Locator:

[legend]

Public Types
typedef LocatorPtr	PointerType
typedef LocatorPrx	ProxyType

Public Member Functions
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.
virtual	~Locator ()
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)
Shared &	operator= (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::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 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

◆ PointerType

typedef LocatorPtr Ice::Locator::PointerType

◆ ProxyType

typedef LocatorPrx Ice::Locator::ProxyType

Constructor & Destructor Documentation

◆ ~Locator()

virtual Ice::Locator::~Locator ( )

virtual

Reimplemented in IceGrid::Locator.

Member Function Documentation

◆ findAdapterById_async()

virtual void Ice::Locator::findAdapterById_async	(	const ::Ice::AMD_Locator_findAdapterByIdPtr &	cb,
		const ::std::string &	id,
		const Current &	current = emptyCurrent ) const

pure virtual

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

Parameters

cb	The AMD callback object for the invocation.
id	The adapter id.
current	The Current object for the invocation.

Exceptions

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

◆ findObjectById_async()

virtual void Ice::Locator::findObjectById_async	(	const ::Ice::AMD_Locator_findObjectByIdPtr &	cb,
		const Identity &	id,
		const Current &	current = emptyCurrent ) 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

cb	The AMD callback object for the invocation.
id	The identity.
current	The Current object for the invocation.

Exceptions

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

◆ getRegistry()

virtual LocatorRegistryPrx Ice::Locator::getRegistry ( const Current & current = emptyCurrent ) const

pure virtual

Get the locator registry.

Parameters

current The Current object for the invocation.

Returns: The locator registry.

◆ ice_id()

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

virtual

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

virtual

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

virtual

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

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/cpp98/x64/Release/Ice/Locator.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~Locator()

Member Function Documentation

◆ findAdapterById_async()

◆ findObjectById_async()

◆ getRegistry()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()