TAO/tao/Transport_Timer.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file Transport_Timer.h
   6  *
   7  *  @author Carlos O'Ryan <coryan@uci.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_TRANSPORT_TIMER_H
  12 #define TAO_TRANSPORT_TIMER_H
  13
  14 #include /**/ "ace/pre.h"
  15 #include "ace/Event_Handler.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include /**/ "tao/TAO_Export.h"
  22 #include /**/ "tao/Versioned_Namespace.h"
  23
  24 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 class TAO_Transport;
  27
  28 /**
  29  * @class TAO_Transport_Timer
  30  *
  31  * @brief Allows TAO_Transport instances to receive timeout
  32  *        notifications from the Reactor.  In other words, implements
  33  *        the Adapter Role, of the Adapter Pattern, where the Adaptee
  34  *        is a TAO_Transport and the client is the Reactor.
  35  */
  36 class TAO_Transport_Timer : public ACE_Event_Handler
  37 {
  38 public:
  39   /// Constructor
  40   /**
  41    * @param transport The adaptee
  42    */
  43   TAO_Transport_Timer (TAO_Transport *transport);
  44
  45   /// Receive timeout events from the Reactor and forward them to the
  46   /// TAO_Transport
  47   virtual int handle_timeout (const ACE_Time_Value &current_time,
  48                               const void *act);
  49 private:
  50   /// The Adaptee
  51   TAO_Transport *transport_;
  52 };
  53
  54 TAO_END_VERSIONED_NAMESPACE_DECL
  55
  56 #include /**/ "ace/post.h"
  57
  58 #endif  /* TAO_TRANSPORT_TIMER_H */