TAO/tao/Client_Strategy_Factory.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file     Client_Strategy_Factory.h
   6  *
   7  *  @author  Chris Cleeland <cleeland@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef TAO_CLIENT_STRATEGY_FACTORY_H
  13 #define TAO_CLIENT_STRATEGY_FACTORY_H
  14
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "tao/TAO_Export.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #include /**/ "tao/Versioned_Namespace.h"
  24 #include "tao/Basic_Types.h"
  25
  26 #include "ace/Service_Object.h"
  27
  28 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  29 class ACE_Lock;
  30 ACE_END_VERSIONED_NAMESPACE_DECL
  31
  32 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  33
  34 namespace TAO
  35 {
  36   struct Invocation_Retry_Params;
  37 }
  38
  39 class TAO_Transport_Mux_Strategy;
  40 class TAO_Wait_Strategy;
  41 class TAO_Transport;
  42 class TAO_ORB_Core;
  43 class TAO_Connect_Strategy;
  44
  45 namespace Messaging
  46 {
  47   typedef ::CORBA::Short SyncScope;
  48 }
  49
  50 /**
  51  * @class TAO_Client_Strategy_Factory
  52  *
  53  * @brief Abstract factory used by the client to manufacture various
  54  * strategies used on the client-side.
  55  */
  56 class TAO_Export TAO_Client_Strategy_Factory : public ACE_Service_Object
  57 {
  58 public:
  59   /// Destructor
  60   virtual ~TAO_Client_Strategy_Factory ();
  61
  62   /// Create the correct client request muxing strategy.
  63   virtual TAO_Transport_Mux_Strategy *create_transport_mux_strategy (TAO_Transport *transport) = 0;
  64
  65   /// Create the correct lock for request muxing strategy.
  66   virtual ACE_Lock *create_transport_mux_strategy_lock () = 0;
  67
  68   /// Return the size of the reply dispatcher table
  69   virtual int reply_dispatcher_table_size () const = 0;
  70
  71   /// Create the correct client wait_for_reply strategy.
  72   virtual TAO_Wait_Strategy *create_wait_strategy (TAO_Transport *transport) = 0;
  73
  74   /// Create the correct client asynch_connect strategy.
  75   virtual TAO_Connect_Strategy *create_connect_strategy (TAO_ORB_Core *) = 0;
  76
  77   enum Connect_Strategy
  78   {
  79     TAO_BLOCKED_CONNECT,
  80     TAO_REACTIVE_CONNECT,
  81     TAO_LEADER_FOLLOWER_CONNECT
  82   };
  83
  84   /// Return the selected connection strategy option.
  85   virtual Connect_Strategy connect_strategy () const = 0;
  86
  87   /// Does the client allow any form of callback?
  88   virtual int allow_callback () = 0;
  89
  90   /// Cleanup options for wait strategy.
  91   /**
  92     * Only applicable to RW wait strategy
  93   */
  94   virtual bool use_cleanup_options () const = 0;
  95
  96   /// Return the parameters used to optionally retry invocation
  97   /// after an exception occurs.
  98   virtual const TAO::Invocation_Retry_Params &invocation_retry_params () const = 0;
  99
 100   /// Return the value to be used as the default sync scope for the ORB
 101   virtual Messaging::SyncScope sync_scope () const = 0;
 102 };
 103
 104 TAO_END_VERSIONED_NAMESPACE_DECL
 105
 106 #include /**/ "ace/post.h"
 107 #endif /* TAO_CLIENT_STRATEGY_FACTORY_H */