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

Base class for a dispatch interceptor, which is a servant that dispatches requests to another servant. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::DispatchInterceptor:
Collaboration diagram for Ice::DispatchInterceptor:

Public Member Functions

virtual bool dispatch (Request &req)=0
 Called by the Ice run time when a new request needs to be dispatched.
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 const std::string & ice_id (const Current &current=Ice::emptyCurrent) const
 Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string > ice_ids (const Current &current=Ice::emptyCurrent) const
 Returns the Slice type IDs of the interfaces supported by this object.
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 ()

Additional Inherited Members

Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type.
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

Base class for a dispatch interceptor, which is a servant that dispatches requests to another servant.

A subclass must implement the dispatch method. A dispatch interceptor can be registered with an object adapter just like any other servant.

Member Function Documentation

◆ dispatch()

virtual bool Ice::DispatchInterceptor::dispatch ( Request & req)
pure virtual

Called by the Ice run time when a new request needs to be dispatched.

The implementation must eventually call ice_dispatch on the delegate servant and pass the given request object.

Parameters
reqAn opaque object representing the request to be dispatched.
Returns
True if the request was dispatched synchronously, or false if the request was dispatched asynchronously.

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