ACE/examples/Timer_Queue/Async_Timer_Queue_Test.h

   1 /* -*- C++ -*- */
   2
   3
   4 //=============================================================================
   5 /**
   6  *  @file    Async_Timer_Queue_Test.h
   7  *
   8  *    This test exercises the <ACE_Asynch_Timer_Queue_Adapter>
   9  *    using an <ACE_Timer_Heap>.
  10  *
  11  *  @author Douglas C. Schmidt and Sergio Flores-Gaitan
  12  */
  13 //=============================================================================
  14
  15
  16 #ifndef _ASYNC_TIMER_QUEUE_TEST_H_
  17 #define _ASYNC_TIMER_QUEUE_TEST_H_
  18
  19 #include "ace/Signal.h"
  20 #include "ace/svc_export.h"
  21
  22 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  23 # pragma once
  24 #endif /* ACE_LACKS_PRAGMA_ONCE */
  25
  26 #include "ace/Timer_Heap.h"
  27 #include "ace/Timer_Queue_Adapters.h"
  28
  29 #include "Driver.h"
  30
  31 /**
  32  * @class Async_Timer_Handler
  33  *
  34  * @brief Target of the asynchronous timeout operation.
  35  */
  36 class Async_Timer_Handler : public ACE_Event_Handler
  37 {
  38 public:
  39   /// Callback hook invoked by the <Timer_Queue>.
  40   virtual int handle_timeout (const ACE_Time_Value &tv,
  41                               const void *arg);
  42 };
  43
  44 /**
  45  * @class Async_Timer_Queue
  46  *
  47  * @brief Asynchronous Timer Queue Singleton.
  48  *
  49  * We use this class to avoid global variables and to
  50  * consolidate all the Timer Queue processing in one central
  51  * place.
  52  */
  53 class Async_Timer_Queue
  54 {
  55 public:
  56   typedef int (Async_Timer_Queue::*ACTION) (void *);
  57
  58    /// Singleton access point.
  59   static Async_Timer_Queue *instance ();
  60
  61   /// Schedule a timer to expire <microsecs> in the future.
  62   void schedule (u_int microsecs);
  63
  64   /// Cancel a timer with <timer_id>.
  65   void cancel (long timer_id);
  66
  67   /// Dump the contents of the queue.
  68   void dump ();
  69
  70   /// hook method to schedule a timer.  Called from
  71   /// <Timer_Queue_Test_Driver>
  72   int schedule_timer (void *argument);
  73
  74   /// hook method to cancel a timer.  Called from
  75   /// <Timer_Queue_Test_Driver>
  76   int cancel_timer (void *argument);
  77
  78   /// hook method to list timers.  Called from
  79   /// <Timer_Queue_Test_Driver>
  80   int list_timer (void *argument);
  81
  82   /// hook method to exit the timer queue.  Called from
  83   /// <Timer_Queue_Test_Driver>
  84   int shutdown_timer (void *argument);
  85
  86 private:
  87   /// Private constructor enforces the Singleton.
  88   Async_Timer_Queue (ACE_Sig_Set *);
  89
  90   /// Pointer to the timer queue.
  91   static Async_Timer_Queue *instance_;
  92
  93   /// The adapter is instantiated by an <ACE_Timer_Heap>.
  94   ACE_Async_Timer_Queue_Adapter<ACE_Timer_Heap> tq_;
  95 };
  96
  97 /**
  98  * @class Async_Timer_Queue_Test_Driver
  99  *
 100  * @brief Async_Timer_Queue_Test_Driver
 101  *
 102  * This class implements a test driver for the
 103  * <Async_Timer_Queue>.  Implements a display_menu() method that
 104  * prints the options for a user. and init() which initializes
 105  * the driver.  The rest of the common functionality is in the
 106  * parent class <Timer_Queue_Test_Driver>.
 107  */
 108 class ACE_Svc_Export Async_Timer_Queue_Test_Driver : public Timer_Queue_Test_Driver <Async_Timer_Queue *, Async_Timer_Queue, Async_Timer_Queue::ACTION>
 109 {
 110 public:
 111   Async_Timer_Queue_Test_Driver ();
 112
 113   /// Print menu of options.
 114   virtual int display_menu ();
 115
 116   /// Initializes the driver's internal variables inherited from the parent
 117   virtual int init ();
 118 };
 119
 120 #endif /* _ASYNC_TIMER_QUEUE_TEST_H_ */