ClientRequestDetails.h

Go to the documentation of this file.

// -*- C++ -*-

//=============================================================================
/**
 *  @file    ClientRequestDetails.h
 *
 *  ClientRequestDetails.h,v 1.3 2006/03/10 07:19:12 jtc Exp
 *
 *   This file declares a class that manages the details
 *   about a registered client request interceptor.  Policies can be
 *   used when interceptors are registered, and the policy values
 *   will be processed and used to modify the values of the
 *   ClientRequestDetails object associated with the registered
 *   client request interceptor.
 *
 *  @author  Tim Bradley <bradley_t@ociweb.com>
 */
//=============================================================================

#ifndef TAO_CLIENT_REQUEST_DETAILS_H
#define TAO_CLIENT_REQUEST_DETAILS_H

#include /**/ "ace/pre.h"

#include "tao/orbconf.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#if TAO_HAS_INTERCEPTORS == 1

#include "tao/PI/ProcessingModePolicyC.h"

TAO_BEGIN_VERSIONED_NAMESPACE_DECL

namespace TAO
{
  /**
   * @class ClientRequestDetails
   *
   * @brief The policy-driven details for a registered client request
   *        interceptor
   *
   * Each time a client request interceptor is registered with an ORB,
   * a ClientRequestDetails object will be created and associated with
   * the registered client request interceptor.  If the interceptor is
   * registered with policies, the policies will be used to adjust the
   * values in the ClientRequestDetails appropriately.
   */
  class ClientRequestDetails
  {
  public:

    ClientRequestDetails (void);

    void apply_policies (const CORBA::PolicyList& policies
                         ACE_ENV_ARG_DECL);

    /// Returns true if the ProcessingMode setting permits the "firing"
    /// of the associated client request interceptor based upon the
    /// remote vs. collocated nature of the current servant request
    /// that is being dispatched.
    bool should_be_processed (bool is_remote_request) const;

  private:

    /// The ProcessingMode setting that can be adjusted via the
    /// PortableInterceptor::ProcessingModePolicy.
    PortableInterceptor::ProcessingMode processing_mode_;
  };
}

TAO_END_VERSIONED_NAMESPACE_DECL

#if defined (__ACE_INLINE__)
#include "tao/PI/ClientRequestDetails.inl"
#endif  /* __ACE_INLINE__ */

#endif  /* TAO_HAS_INTERCEPTORS == 1 */

#include /**/ "ace/post.h"

#endif /* TAO_CLIENT_REQUEST_DETAILS_H */

---