Ice 3.7 C++98 API Reference
Loading...
Searching...
No Matches
Ice::LocatorRegistry Class Referenceabstract

The Ice locator registry interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::LocatorRegistry:
Collaboration diagram for Ice::LocatorRegistry:

Public Types

typedef LocatorRegistryPtr PointerType
typedef LocatorRegistryPrx ProxyType

Public Member Functions

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 void setAdapterDirectProxy_async (const ::Ice::AMD_LocatorRegistry_setAdapterDirectProxyPtr &cb, const ::std::string &id, const ObjectPrx &proxy, const Current &current=emptyCurrent)=0
 Set the adapter endpoints with the locator registry.
virtual void setReplicatedAdapterDirectProxy_async (const ::Ice::AMD_LocatorRegistry_setReplicatedAdapterDirectProxyPtr &cb, const ::std::string &adapterId, const ::std::string &replicaGroupId, const ObjectPrx &p, const Current &current=emptyCurrent)=0
 Set the adapter endpoints with the locator registry.
virtual void setServerProcessProxy_async (const ::Ice::AMD_LocatorRegistry_setServerProcessProxyPtr &cb, const ::std::string &id, const ProcessPrx &proxy, const Current &current=emptyCurrent)=0
 Set the process proxy for a server.
virtual ~LocatorRegistry ()
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::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 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

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~LocatorRegistry()

virtual Ice::LocatorRegistry::~LocatorRegistry ( )
virtual

Member Function Documentation

◆ ice_id()

virtual const ::std::string & Ice::LocatorRegistry::ice_id ( const Current & current = 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.

Reimplemented from Ice::Object.

◆ ice_ids()

virtual ::std::vector< ::std::string > Ice::LocatorRegistry::ice_ids ( const Current & current = emptyCurrent) const
virtual

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.

Reimplemented from Ice::Object.

◆ ice_isA()

virtual bool Ice::LocatorRegistry::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
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 & Ice::LocatorRegistry::ice_staticId ( )
static

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

◆ setAdapterDirectProxy_async()

virtual void Ice::LocatorRegistry::setAdapterDirectProxy_async ( const ::Ice::AMD_LocatorRegistry_setAdapterDirectProxyPtr & cb,
const ::std::string & id,
const ObjectPrx & proxy,
const Current & current = emptyCurrent )
pure virtual

Set the adapter endpoints with the locator registry.

Parameters
cbThe AMD callback object for the invocation.
idThe adapter id.
proxyThe adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
currentThe Current object for the invocation.
Exceptions
Ice::AdapterAlreadyActiveExceptionRaised if an adapter with the same id is already active.
Ice::AdapterNotFoundExceptionRaised 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.

◆ setReplicatedAdapterDirectProxy_async()

virtual void Ice::LocatorRegistry::setReplicatedAdapterDirectProxy_async ( const ::Ice::AMD_LocatorRegistry_setReplicatedAdapterDirectProxyPtr & cb,
const ::std::string & adapterId,
const ::std::string & replicaGroupId,
const ObjectPrx & p,
const Current & current = emptyCurrent )
pure virtual

Set the adapter endpoints with the locator registry.

Parameters
cbThe AMD callback object for the invocation.
adapterIdThe adapter id.
replicaGroupIdThe replica group id.
pThe adapter proxy (a dummy direct proxy created by the adapter). The direct proxy contains the adapter endpoints.
currentThe Current object for the invocation.
Exceptions
Ice::AdapterAlreadyActiveExceptionRaised if an adapter with the same id is already active.
Ice::AdapterNotFoundExceptionRaised 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::InvalidReplicaGroupIdExceptionRaised if the given replica group doesn't match the one registered with the locator registry for this object adapter.

◆ setServerProcessProxy_async()

virtual void Ice::LocatorRegistry::setServerProcessProxy_async ( const ::Ice::AMD_LocatorRegistry_setServerProcessProxyPtr & cb,
const ::std::string & id,
const ProcessPrx & proxy,
const Current & current = emptyCurrent )
pure virtual

Set the process proxy for a server.

Parameters
cbThe AMD callback object for the invocation.
idThe server id.
proxyThe process proxy.
currentThe Current object for the invocation.
Exceptions
Ice::ServerNotFoundExceptionRaised if the server cannot be found.

The documentation for this class was generated from the following file: