TAO/tao/Messaging/Messaging_Queueing_Strategies.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Messaging_Queueing_Strategies.h
   6  *
   7  *  Queueing strategies for the ORB Messaging layer.
   8  *
   9  *  @author  Irfan Pyarali
  10  */
  11 //=============================================================================
  12
  13
  14 #ifndef TAO_MESSAGING_QUEUEING_STRATEGIES_H
  15 #define TAO_MESSAGING_QUEUEING_STRATEGIES_H
  16
  17 #include /**/ "ace/pre.h"
  18
  19 #include /**/ "tao/TAO_Export.h"
  20
  21 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  22 # pragma once
  23 #endif /* ACE_LACKS_PRAGMA_ONCE */
  24
  25 #include "tao/orbconf.h"
  26 #include "tao/Basic_Types.h"
  27 #include "tao/Transport_Queueing_Strategies.h"
  28
  29 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  30
  31 namespace TAO
  32 {
  33   struct BufferingConstraint;
  34 }
  35
  36 namespace TimeBase
  37 {
  38   typedef CORBA::ULongLong TimeT;
  39 }
  40
  41 namespace TAO
  42 {
  43   #if (TAO_HAS_BUFFERING_CONSTRAINT_POLICY == 1)
  44
  45   class Eager_Transport_Queueing_Strategy : public Transport_Queueing_Strategy
  46   {
  47   public:
  48     bool must_queue (bool queue_empty) const override;
  49
  50     bool buffering_constraints_reached (
  51       TAO_Stub *stub,
  52       size_t msg_count,
  53       size_t total_bytes,
  54       bool &must_flush,
  55       const ACE_Time_Value &current_deadline,
  56       bool &set_timer,
  57       ACE_Time_Value &new_deadline) const override;
  58
  59   private:
  60     /// Check if the buffering constraint includes any timeouts and
  61     /// compute the right timeout interval if needed.
  62     /**
  63      * @param buffering_constraint The constraints defined by the
  64      *        application
  65      * @param current_deadline The current deadline
  66      * @param set_timer Return true if the timer should be set
  67      * @param new_deadline Return the timer interval value
  68      *
  69      * @return Returns true if the deadline has already expired and
  70      *         flushing must commence immediately.  If the function
  71      *         returns false then flushing may need to be delayed, use @c
  72      *         set_timer and
  73      */
  74     bool timer_check (const TAO::BufferingConstraint &buffering_constraint,
  75                       const ACE_Time_Value &current_deadline,
  76                       bool &set_timer,
  77                       ACE_Time_Value &new_deadline) const;
  78
  79     /// Convert from standard CORBA time units to seconds/microseconds.
  80     ACE_Time_Value time_conversion (const TimeBase::TimeT &time) const;
  81   };
  82
  83   /// Delay the buffering decision until the transport blocks
  84   /**
  85    * If the queue is empty the transport will try to send immediately.
  86    */
  87   class Delayed_Transport_Queueing_Strategy
  88     : public Eager_Transport_Queueing_Strategy
  89   {
  90   public:
  91     bool must_queue (bool queue_empty) const override;
  92   };
  93
  94   #endif /* TAO_HAS_BUFFERING_CONSTRAINT_POLICY == 1 */
  95
  96 }
  97
  98 TAO_END_VERSIONED_NAMESPACE_DECL
  99
 100 #include /**/ "ace/post.h"
 101
 102 #endif /* TAO_MESSAGING_QUEUEING_STRATEGIES_H */