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

1 files changed, 173 insertions, 0 deletions

diff --git a/TAO/tao/Profile_Transport_Resolver.h b/TAO/tao/Profile_Transport_Resolver.h
new file mode 100644
index 00000000000..380a69c9872
--- /dev/null
+++ b/TAO/tao/Profile_Transport_Resolver.h
@@ -0,0 +1,173 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ *  @file    Profile_Transport_Resolver.h
+ *
+ *  $Id$
+ *
+ *
+ *  @author Balachandran Natarajan <bala@dre.vanderbilt.edu>
+ */
+//=============================================================================
+
+#ifndef TAO_PROFILE_TRANSPORT_RESOLVER_H
+#define TAO_PROFILE_TRANSPORT_RESOLVER_H
+
+#include /**/ "ace/pre.h"
+#include "ace/Global_Macros.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+#include "ace/CORBA_macros.h"
+
+#include "tao/Exception.h"
+
+class TAO_Stub;
+class TAO_Profile;
+class TAO_Transport;
+class TAO_Endpoint;
+class ACE_Time_Value;
+class TAO_Transport_Descriptor_Interface;
+
+namespace CORBA
+{
+  class SystemException;
+  class Environment;
+  class Object;
+  class PolicyList;
+
+  class Object;
+  typedef Object *Object_ptr;
+}
+
+namespace TAO
+{
+  class Synch_Twoway_Invocation;
+
+  /**
+   * @class Profile_Transport_Resolver
+   *
+   * @brief Chooses the profile and a transport for a target object on
+   * which an invocation can be made.
+   *
+   * A target object is represented by multiple profiles, which
+   * theoretically provides multiple paths to the same target
+   * object. This class helps in choosing the right profile, and pick
+   * a transport from cache (or create a new transport if needed) that
+   * represents the profile.
+   *
+   */
+  class TAO_Export Profile_Transport_Resolver
+  {
+  public:
+    Profile_Transport_Resolver (CORBA::Object *ep,
+                                TAO_Stub *);
+
+    ~Profile_Transport_Resolver (void);
+
+    /// Method where the bunch of the action takes place.
+    /**
+     * This is the entry point from the TAO::Invocation_Adapter
+     * class. This method accesses the endpoint selector factory from
+     * the ORB_Core to decide on the strategy to be used for selecting
+     * the profile.
+     */
+    void resolve (ACE_Time_Value *val
+                  ACE_ENV_ARG_DECL)
+      ACE_THROW_SPEC ((CORBA::SystemException));
+
+
+    //@{
+    /**
+     * Accessors and muttators for this class. The following methods
+     * are used by the clients of this class to access.
+     */
+
+    /// Accessors and mutators for profile.
+    void profile (TAO_Profile *pfile);
+    TAO_Profile *profile (void) const;
+
+    /// Accessor for TAO_Stub
+    TAO_Stub *stub (void) const;
+
+    /// Accessor for the target in use
+    CORBA::Object *object (void) const;
+
+    /// Accessor for the transport reserved for this invocation.
+    TAO_Transport *transport (void) const;
+    //@}
+
+    /// Signal to let the resolver know that the transport has been
+    /// released back to the cache.
+    void transport_released (void) const;
+
+    /// This is a callback method used by the endpoint selectors, to
+    /// delegate the responsibility of reserving a transport from the
+    /// connection cache for this invocation.
+    bool try_connect (TAO_Transport_Descriptor_Interface *desc,
+                      ACE_Time_Value *val
+                      ACE_ENV_ARG_DECL);
+
+    /// Intialize the inconsistent policy list that this object has
+    /// cached.
+    void init_inconsistent_policies (ACE_ENV_SINGLE_ARG_DECL)
+      ACE_THROW_SPEC ((CORBA::SystemException));
+
+    CORBA::PolicyList *inconsistent_policies (void) const;
+
+    CORBA::PolicyList *steal_inconsistent_policies (void);
+  private:
+
+    /// Helper method to access get the connection timeout from the
+    /// ORB.
+    bool get_connection_timeout (ACE_Time_Value &max_wait_time);
+
+  private:
+
+    /// Target object
+    mutable CORBA::Object *obj_;
+
+    /// Stub object for the target object.
+    TAO_Stub *stub_;
+
+    /// The transport selected for this invocation.
+    TAO_Transport *transport_;
+
+    /// The profile that has been selected for this invocation.
+    TAO_Profile *profile_;
+
+    /// Has the transport been idled?
+    mutable bool is_released_;
+
+    /// List of inconsistent policies
+    /**
+     * If current effective policies cause the invocation to raise
+     * CORBA::INV_POLICY exception, the conflicting/problematic policies
+     * are stored in this list.  This is used by \param
+     * Object::_validate_connection method to inform clients about
+     * causes of invocation failure.
+     * @par
+     * Conflicting policies are only stored in this list if \param
+     * init_inconsistent_policies method has been called prior to the
+     * beginning of invocation.  This saves extra work of conflicting
+     * policies 'logging' when it's not needed.
+     *
+     * @NOTE: We don't use _var with a reason. Using _var would
+     * involve including the  header file for atleast
+     * Policy_ForwardC.h, and that is what we precisely want to
+     * avoid.
+     */
+    CORBA::PolicyList *inconsistent_policies_;
+  };
+} // TAO namespace end
+
+#if defined (__ACE_INLINE__)
+# include "Profile_Transport_Resolver.inl"
+#endif /* __ACE_INLINE__ */
+
+#include /**/ "ace/post.h"
+
+#endif /*TAO_PROFILE_TRANSPORT_RESOLVER_H*/