TAO/tao/Connect_Strategy.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file Connect_Strategy.h
   6  *
   7  *  @author Balachandran Natarajan <bala@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_CONNECT_STRATEGY_H
  12 #define TAO_CONNECT_STRATEGY_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include /**/ "tao/TAO_Export.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include /**/ "tao/Versioned_Namespace.h"
  23
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25 class ACE_Synch_Options;
  26 class ACE_Time_Value;
  27 ACE_END_VERSIONED_NAMESPACE_DECL
  28
  29 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  30
  31 class TAO_ORB_Core;
  32 class TAO_Connector;
  33 class TAO_Connection_Handler;
  34 class TAO_Transport;
  35 class TAO_LF_Multi_Event;
  36 class TAO_LF_Event;
  37
  38 /**
  39  * @class TAO_Connect_Strategy
  40  *
  41  * @brief Define the interface for the connect strategy, i.e. the
  42  *  algorithm that controls how does the ORB establishes remote
  43  *  connections.
  44  *
  45  * The thread that establishes remote connections can either make a
  46  * blocking or a non-blocking connect. The strategy to wait for the
  47  * connection completion can also be different.
  48  *
  49  * This strategy controls how does the ORB schedules and waits for
  50  * connection completion.
  51  */
  52
  53 class TAO_Export TAO_Connect_Strategy
  54 {
  55 public:
  56   /// Constructor
  57   TAO_Connect_Strategy (TAO_ORB_Core *orb);
  58
  59   /// Destructor
  60   virtual ~TAO_Connect_Strategy () = default;
  61
  62   /// Obtain the synch options that can be passed to ACE_Connector
  63   /**
  64    * Return the synch option for the connector, based on the timeout
  65    * and the strategy in place. ACE_Connectors behavior can be altered
  66    * by passing the right ACE_Synch_Options to the connect () call.
  67    */
  68   virtual void synch_options (ACE_Time_Value *val,
  69                               ACE_Synch_Options &opt) = 0;
  70
  71   /// Wait for the connection to be completed till a timeout occurs.
  72   /**
  73    * If the connection establishment fails the state within the
  74    * connection handler is set appropriately.
  75    */
  76   int wait (TAO_Connection_Handler *ch, ACE_Time_Value *val);
  77
  78   int wait (TAO_Transport *t, ACE_Time_Value *val);
  79
  80   /// Wait for one of many connections to complete. Returns when one
  81   /// succeeds or all fail.
  82   int wait (TAO_LF_Multi_Event *ev, ACE_Time_Value *val);
  83
  84   /// Do a quick check to see if any connections are complete. This
  85   /// does the same as the wait with an explicit time value of 0.
  86   int poll (TAO_LF_Multi_Event *ev);
  87
  88 protected:
  89   /// This is the method that does all the real interesting stuff.
  90   virtual int wait_i (TAO_LF_Event *ev,
  91                       TAO_Transport *t,
  92                       ACE_Time_Value *val) = 0;
  93
  94   /// Cached copy of the ORB core pointer
  95   TAO_ORB_Core * const orb_core_;
  96 };
  97
  98 TAO_END_VERSIONED_NAMESPACE_DECL
  99
 100 #include /**/ "ace/post.h"
 101 #endif /*TAO_CONNECT_STRATEGY_H*/