TAO/tao/PI/ClientRequestDetails.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    ClientRequestDetails.h
   6  *
   7  *   This file declares a class that manages the details
   8  *   about a registered client request interceptor.  Policies can be
   9  *   used when interceptors are registered, and the policy values
  10  *   will be processed and used to modify the values of the
  11  *   ClientRequestDetails object associated with the registered
  12  *   client request interceptor.
  13  *
  14  *  @author  Tim Bradley <bradley_t@ociweb.com>
  15  */
  16 //=============================================================================
  17
  18 #ifndef TAO_CLIENT_REQUEST_DETAILS_H
  19 #define TAO_CLIENT_REQUEST_DETAILS_H
  20
  21 #include /**/ "ace/pre.h"
  22
  23 #include "tao/orbconf.h"
  24
  25 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  26 # pragma once
  27 #endif /* ACE_LACKS_PRAGMA_ONCE */
  28
  29 #if TAO_HAS_INTERCEPTORS == 1
  30
  31 #include "tao/PI/PI_includeC.h"
  32
  33 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  34
  35 namespace TAO
  36 {
  37   /**
  38    * @class ClientRequestDetails
  39    *
  40    * @brief The policy-driven details for a registered client request
  41    *        interceptor
  42    *
  43    * Each time a client request interceptor is registered with an ORB,
  44    * a ClientRequestDetails object will be created and associated with
  45    * the registered client request interceptor.  If the interceptor is
  46    * registered with policies, the policies will be used to adjust the
  47    * values in the ClientRequestDetails appropriately.
  48    */
  49   class ClientRequestDetails
  50   {
  51   public:
  52     ClientRequestDetails ();
  53
  54     void apply_policies (const CORBA::PolicyList& policies);
  55
  56     /// Returns true if the ProcessingMode setting permits the "firing"
  57     /// of the associated client request interceptor based upon the
  58     /// remote vs. collocated nature of the current servant request
  59     /// that is being dispatched.
  60     bool should_be_processed (bool is_remote_request) const;
  61
  62   private:
  63     /// The ProcessingMode setting that can be adjusted via the
  64     /// PortableInterceptor::ProcessingModePolicy.
  65     PortableInterceptor::ProcessingMode processing_mode_;
  66   };
  67 }
  68
  69 TAO_END_VERSIONED_NAMESPACE_DECL
  70
  71 #if defined (__ACE_INLINE__)
  72 #include "tao/PI/ClientRequestDetails.inl"
  73 #endif  /* __ACE_INLINE__ */
  74
  75 #endif  /* TAO_HAS_INTERCEPTORS == 1 */
  76
  77 #include /**/ "ace/post.h"
  78
  79 #endif /* TAO_CLIENT_REQUEST_DETAILS_H */