TAO/tao/Invocation_Retry_State.h

   1 /* -*- C++ -*-  */
   2 //=============================================================================
   3 /**
   4  *  @file   Invocation_Retry_State.h
   5  *
   6  *  @author Byron Harris (harrisb@ociweb.com)
   7  */
   8 //=============================================================================
   9
  10 #ifndef TAO_INVOCATION_RETRY_STATE_H
  11 #define TAO_INVOCATION_RETRY_STATE_H
  12
  13 #include "tao/Stub.h"
  14 #include "tao/Invocation_Retry_Params.h"
  15
  16 #include "ace/Array_Map.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  23
  24 namespace TAO
  25 {
  26   /**
  27    * @class Invocation_Retry_State
  28    *
  29    * @brief Maintains state of invocation retries.
  30    */
  31   class Invocation_Retry_State
  32   {
  33   public:
  34     Invocation_Retry_State (TAO_Stub &stub);
  35
  36     ~Invocation_Retry_State ();
  37
  38     /**
  39      * Answer if any profile forward on exception limit
  40      * parameter is used.
  41      */
  42     bool forward_on_exception_limit_used () const;
  43
  44     /**
  45      * Attempt to increment the count of profile
  46      * forwards.
  47      * @return false if forward on exception is not
  48      * being used or the limit has been reached.
  49      */
  50     bool forward_on_exception_increment (const int ef);
  51
  52     /**
  53      * Attempt to increment the count of retries
  54      * when a server connection is seen as closed
  55      * during reply.
  56      */
  57     bool forward_on_reply_closed_increment ();
  58
  59     /**
  60      * Increment to next profile in preparation
  61      * to retry using that profile.
  62      * If the next profile is the starting
  63      * base profile then also call
  64      * sleep ().
  65      * @see TAO_Stub::next_profile_retry()
  66      */
  67     void next_profile_retry (TAO_Stub &stub) const;
  68
  69     /**
  70      * Sleep if profile is the starting
  71      * base profile.
  72      */
  73     void sleep_at_starting_profile (TAO_Stub &stub) const;
  74
  75     /**
  76      * Sleep according to the delay value
  77      * in Invocation_Retry_Params.
  78      */
  79     void sleep () const;
  80
  81   private:
  82     typedef ACE_Array_Map<int, int> Ex_Count_Map;
  83     Ex_Count_Map ex_count_map_;
  84     int forward_on_reply_closed_count_;
  85     Invocation_Retry_Params retry_params_;
  86     bool forward_on_exception_limit_used_;
  87   };
  88 }
  89
  90 TAO_END_VERSIONED_NAMESPACE_DECL
  91
  92 #endif /* TAO_INVOCATION_RETRY_STATE_H*/