Ice 3.7 C++11 API Reference
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for Ice::DispatchInterceptor:
Collaboration graph
[legend]

Public Member Functions

virtual bool dispatch (Request &req)=0
 Called by the Ice run time when a new request needs to be dispatched. More...
 
- Public Member Functions inherited from Ice::Object
virtual bool ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
 Dispatches an invocation to a servant. More...
 
virtual std::string ice_id (const Current &current) const
 Returns the Slice type ID of the most-derived interface supported by this object. More...
 
virtual std::vector< std::string > ice_ids (const Current &current) const
 Returns the Slice type IDs of the interfaces supported by this object. More...
 
virtual bool ice_isA (std::string s, const Current &current) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual void ice_ping (const Current &current) const
 Tests whether this object can be reached. More...
 
virtual ~Object ()=default
 

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. More...
 

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: