Ice 3.7 C++98 API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Ice::RouterFinder Class Referenceabstract

This inferface should be implemented by services implementing the Ice::Router interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::RouterFinder:
Inheritance graph
[legend]
Collaboration diagram for Ice::RouterFinder:
Collaboration graph
[legend]

Public Types

typedef RouterFinderPtr PointerType
 
typedef RouterFinderPrx ProxyType
 

Public Member Functions

virtual RouterPrx getRouter (const Current &current=emptyCurrent)=0
 Get the router proxy implemented by the process hosting this finder object. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual ~RouterFinder ()
 
- Public Member Functions inherited from Ice::Object
virtual ObjectPtr ice_clone () const
 Returns a shallow copy of the object. More...
 
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. More...
 
virtual bool ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
 Dispatches an invocation to a servant. More...
 
virtual SlicedDataPtr ice_getSlicedData () const
 Obtains the sliced data associated with this instance. More...
 
virtual bool ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual Int ice_operationAttributes (const std::string &operation) const
 Returns the Freeze metadata attributes for an operation. More...
 
virtual void ice_ping (const Current &current=Ice::emptyCurrent) const
 Tests whether this object can be reached. More...
 
virtual void ice_postUnmarshal ()
 The Ice run time invokes this method vafter unmarshaling an object's data members. More...
 
virtual void ice_preMarshal ()
 The Ice run time invokes this method prior to marshaling an object's data members. More...
 
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. More...
 
- Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type. More...
 

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

This inferface should be implemented by services implementing the Ice::Router interface.

It should be advertised through an Ice object with the identity `Ice/RouterFinder'. This allows clients to retrieve the router proxy with just the endpoint information of the service.

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~RouterFinder()

virtual Ice::RouterFinder::~RouterFinder ( )
virtual

Member Function Documentation

◆ getRouter()

virtual RouterPrx Ice::RouterFinder::getRouter ( const Current current = emptyCurrent)
pure virtual

Get the router proxy implemented by the process hosting this finder object.

The proxy might point to several replicas.

Parameters
currentThe Current object for the invocation.
Returns
The router proxy.

◆ ice_id()

virtual const ::std::string& Ice::RouterFinder::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::RouterFinder::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::RouterFinder::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()

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