TAO/tao/ClientRequestInterceptor_Adapter.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    ClientRequestInterceptor_Adapter.h
   6  *
   7  *   This file an adapter class to simplify the support of
   8  *   interceptors.
   9  *
  10  *  @author  Nanbor Wang <nanbor@cs.wustl.edu>
  11  *  @author  Ossama Othman <ossama@uci.edu>
  12  *  @author  Kirthika Parameswaran  <kirthika@cs.wustl.edu>
  13  */
  14 //=============================================================================
  15
  16 #ifndef TAO_CLIENT_REQUEST_INTERCEPTOR_ADAPTER_H
  17 #define TAO_CLIENT_REQUEST_INTERCEPTOR_ADAPTER_H
  18
  19 #include /**/ "ace/pre.h"
  20
  21 #include /**/ "tao/TAO_Export.h"
  22 #include "tao/RequestInterceptor_Adapter.h"
  23
  24 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  25 # pragma once
  26 #endif /* ACE_LACKS_PRAGMA_ONCE */
  27
  28 #include "tao/Invocation_Utils.h"
  29 #include "tao/Basic_Types.h"
  30
  31 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  32
  33 class TAO_ClientRequestInfo;
  34
  35 namespace PortableInterceptor
  36 {
  37   class ClientRequestInterceptor;
  38   typedef ClientRequestInterceptor *ClientRequestInterceptor_ptr;
  39
  40   typedef CORBA::Short ReplyStatus;
  41 }
  42
  43 namespace CORBA
  44 {
  45   class PolicyList;
  46 }
  47
  48 namespace TAO
  49 {
  50   class Invocation_Base;
  51
  52   /**
  53    * @class ClientRequestInterceptor_Adapter
  54    *
  55    * @brief A convenient helper class to invoke registered client request
  56    *        interceptors
  57    *
  58    * This class invokes all registered interceptors at interception
  59    * point, and enforces flow rules dictated by the Portable Interceptor
  60    * specification/chapter.
  61    */
  62   class TAO_Export ClientRequestInterceptor_Adapter
  63     : public RequestInterceptor_Adapter
  64   {
  65   public:
  66     virtual ~ClientRequestInterceptor_Adapter ();
  67
  68     /**
  69      * @name PortableInterceptor Client Side Interception Points
  70      *
  71      * Each of these methods corresponds to a client side interception
  72      * point.  There are no "intermediate" interception points on the
  73      * client side, only "starting" and "ending" interception points.
  74      *
  75      */
  76     //@{
  77     /// This method implements one of the "starting" client side
  78     /// interception points.
  79     virtual void send_request (Invocation_Base &invocation) = 0;
  80
  81     /// This method implements one of the "ending" client side
  82     /// interception point.
  83     virtual void receive_reply (Invocation_Base &invocation) = 0;
  84
  85     /// This method implements one of the "ending" client side
  86     /// interception point.
  87     virtual void receive_exception (Invocation_Base &invocation) = 0;
  88
  89     /// This method implements one of the "ending" client side
  90     /// interception point.
  91     virtual void receive_other (Invocation_Base &invocation) = 0;
  92
  93     /// Register an interceptor.
  94     virtual void add_interceptor (
  95       PortableInterceptor::ClientRequestInterceptor_ptr interceptor) = 0;
  96
  97     /// Register an interceptor with policies.
  98     virtual void add_interceptor (
  99       PortableInterceptor::ClientRequestInterceptor_ptr interceptor,
 100       const CORBA::PolicyList& policies) = 0;
 101
 102     /// Convert TAO Invocation status to a PI status
 103     virtual PortableInterceptor::ReplyStatus pi_reply_status (
 104       TAO::Invocation_Base const &invocation_base) = 0;
 105   };
 106 }
 107
 108 TAO_END_VERSIONED_NAMESPACE_DECL
 109
 110 #include /**/ "ace/post.h"
 111
 112 #endif /* TAO_CLIENT_REQUEST_INTERCEPTOR_ADAPTER_H */