diff options
Diffstat (limited to 'cpp/include/Ice/Dispatcher.h')
-rw-r--r-- | cpp/include/Ice/Dispatcher.h | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/cpp/include/Ice/Dispatcher.h b/cpp/include/Ice/Dispatcher.h index c30c240699c..22b1607e4c7 100644 --- a/cpp/include/Ice/Dispatcher.h +++ b/cpp/include/Ice/Dispatcher.h @@ -24,24 +24,44 @@ namespace Ice { +/** + * Encapsulates all the details of a request dispatch or AMI callback. + * The application must eventually invoke run to dispatch the call. + * \headerfile Ice/Ice.h + */ class ICE_API DispatcherCall : public virtual IceUtil::Shared { public: virtual ~DispatcherCall(); + /** + * Dispatches the call. + */ virtual void run() = 0; }; typedef IceUtil::Handle<DispatcherCall> DispatcherCallPtr; +/** + * Base class for a dispatcher. A subclass must define the dispatch method. + * The dispatcher can be installed via InitializationData. + * \headerfile Ice/Ice.h + */ class ICE_API Dispatcher : public virtual IceUtil::Shared { public: virtual ~Dispatcher(); - virtual void dispatch(const DispatcherCallPtr&, const ConnectionPtr&) = 0; + /** + * Called by the Ice run time when an incoming request or an AMI callback needs to + * be dispatched. The implementation must eventually invoke run on the call object. + * @param call An object representing the call that must be dispatched. + * @param connection The connection object associated with the call, or nil if no + * connection is associated with the call. + */ + virtual void dispatch(const DispatcherCallPtr& call, const ConnectionPtr& connection) = 0; }; typedef IceUtil::Handle<Dispatcher> DispatcherPtr; |