ChangeLogTag:Tue Oct 28 12:02:47 2003 Balachandran Natarajan <bala@dre.vanderbilt.edu>

1 files changed, 141 insertions, 0 deletions

diff --git a/TAO/tao/ClientRequestInterceptor_Adapter.h b/TAO/tao/ClientRequestInterceptor_Adapter.h
new file mode 100644
index 00000000000..b5d8de81a31
--- /dev/null
+++ b/TAO/tao/ClientRequestInterceptor_Adapter.h
@@ -0,0 +1,141 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ *  @file    ClientRequestInterceptor_Adapter.h
+ *
+ *  $Id$
+ *
+ *   This file an adapter class to simplify the support of
+ *   interceptors. This file is a modified form of
+ *   ClientInterceptor_Adapter.h
+ *
+ *  @author  Nanbor Wang <nanbor@cs.wustl.edu>
+ *  @author  Ossama Othman <ossama@uci.edu>
+ *  @author  Kirthika Parameswaran  <kirthika@cs.wustl.edu>
+ */
+//=============================================================================
+
+#ifndef TAO_CLIENT_REQUEST_INTERCEPTOR_ADAPTER_H
+#define TAO_CLIENT_REQUEST_INTERCEPTOR_ADAPTER_H
+
+#include /**/ "ace/pre.h"
+
+#include "ace/config-all.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+#include "Interceptor_List.h"
+
+#if TAO_HAS_INTERCEPTORS == 1
+
+class TAO_ClientRequestInfo;
+class TAO_ClientRequestInfo_i;
+
+namespace TAO
+{
+  class Invocation_Base;
+
+  /**
+   * @class ClientRequestInterceptor_Adapter
+   *
+   * @brief A convenient helper class to invoke registered client request
+   *        interceptors
+   *
+   * This class invokes all registered interceptors at interception
+   * point, and enforces flow rules dictated by the Portable Interceptor
+   * specification/chapter.
+   */
+  class TAO_Export ClientRequestInterceptor_Adapter
+  {
+
+  public:
+
+    ClientRequestInterceptor_Adapter (
+        TAO_ClientRequestInterceptor_List::TYPE & interceptors,
+        Invocation_Base *invocation
+      );
+
+    ~ClientRequestInterceptor_Adapter (void);
+
+    /**
+     * @name PortableInterceptor Client Side Interception Points
+     *
+     * Each of these methods corresponds to a client side interception
+     * point.  There are no "intermediate" interception points on the
+     * client side, only "starting" and "ending" interception points.
+     *
+     */
+    //@{
+    /// This method implements one of the "starting" client side
+    /// interception points.
+    void send_request (TAO_ClientRequestInfo_i * ri
+                       ACE_ENV_ARG_DECL);
+
+    /// This method implements one of the "ending" client side
+    /// interception point.
+    void receive_reply (TAO_ClientRequestInfo_i * ri
+                        ACE_ENV_ARG_DECL);
+
+    /// This method implements one of the "ending" client side
+    /// interception point.
+    void receive_exception (TAO_ClientRequestInfo_i * ri
+                            ACE_ENV_ARG_DECL);
+
+    /// This method implements one of the "ending" client side
+    /// interception point.
+    void receive_other (TAO_ClientRequestInfo_i * ri
+                        ACE_ENV_ARG_DECL);
+    //@}
+
+  protected:
+
+    /// Process the given PortableInterceptor::ForwardRequest exception,
+    /// i.e. invoke the receive_other() interception point, in addition
+    /// to notifying the Invocation object of the LOCATION_FORWARD.
+    void process_forward_request (TAO_ClientRequestInfo_i * ri,
+                                  PortableInterceptor::ForwardRequest & exc
+                                  ACE_ENV_ARG_DECL);
+
+  private:
+
+    /// Reference to the list of registered interceptors.
+    TAO_ClientRequestInterceptor_List::TYPE & interceptors_;
+
+    /// Pointer to the GIOP invocation object for the current request.
+    Invocation_Base * invocation_;
+
+    /// Cache the length of the interceptor list so that we don't have
+    /// to compute it at each stage of the current interception.
+    const size_t len_;
+
+    /// The number of interceptors "pushed" onto the logical flow
+    /// stack.  This is used when unwinding the flow stack.
+    size_t stack_size_;
+
+    /// Pointer to the PortableInterceptor::ClientRequestInfo
+    /// implementation.
+    /**
+     * @note The fact that a pointer to the
+     *       PortableInterceptor::ClientRequestInfo object in TSS is
+     *       cached here assumes that all client side interception
+     *       points are invoked in the same thread.  This may not be the
+     *       case for AMI!  In that case, we'll have to perform a TSS
+     *       access in each interception point.
+     */
+    TAO_ClientRequestInfo * info_;
+
+  };
+
+}
+#if defined (__ACE_INLINE__)
+#include "ClientRequestInterceptor_Adapter.inl"
+#endif  /* __ACE_INLINE__ */
+
+#endif /* TAO_HAS_INTERCEPTORS */
+
+#include /**/ "ace/post.h"
+
+#endif /* TAO_CLIENT_REQUEST_INTERCEPTOR_ADAPTER_H */