TAO/examples/Callback_Quoter/Consumer_Input_Handler.h

   1 /* -*- C++ -*- */
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Consumer_Input_Handler.h
   6  *
   7  *  Definition of the Callback_Qouter Consumer Client class, Consumer_Input_Handler.
   8  *
   9  *  @author Kirthika Parameswaran <kirthika@cs.wustl.edu>
  10  */
  11 //=============================================================================
  12
  13
  14 #ifndef CONSUMER_INPUT_HANDLER_H
  15 #define CONSUMER_INPUT_HANDLER_H
  16
  17 #include "ace/Reactor.h"
  18 #include "ace/Event_Handler.h"
  19 #include "Consumer_Handler.h"
  20
  21 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  22 # pragma once
  23 #endif /* ACE_LACKS_PRAGMA_ONCE */
  24
  25 // Creating a class to handle input events.
  26 // Since only inputs need to be handled, only the handle_input
  27 // method is overlaoded.
  28
  29 class Consumer_Handler;
  30
  31 /**
  32  * @class Consumer_Input_Handler
  33  *
  34  * @brief Callback Quoter Consumer Client class.
  35  *
  36  * Connects to the Callback Quoter server and
  37  * registers the Consumer object with the it
  38  * and receives the stock status from the Notifier.
  39  */
  40 class Consumer_Input_Handler : public ACE_Event_Handler
  41 {
  42
  43 public:
  44   /// Constructor.
  45   Consumer_Input_Handler (Consumer_Handler *consumer_handler);
  46
  47   /// Handle the user input.
  48   int handle_input (ACE_HANDLE);
  49
  50   /// Registration with the notifier.
  51   int register_consumer (void);
  52
  53   /// Cancelling the registration with the notifier.
  54   int unregister_consumer (void);
  55
  56   /// Ends the consumer process.
  57   int quit_consumer_process (void);
  58
  59   enum
  60   {
  61     // =  TITLE
  62     //   A set of values for the execution of the consumer.
  63     //
  64     // = DESCRIPTION
  65     //   Used so that the process of registering, unregistering
  66     //   and exiting neednt be dependent on 'r' 'u' and 'q'.
  67     //   Also, #define clutters up the global namespace.
  68
  69     REGISTER = 'r',
  70     // The character that the user must type to register the consumer with
  71     // the Notifier_server.
  72
  73     UNREGISTER = 'u',
  74     // The character that the user must type to unregister the consumer with
  75     // the Notifier_server.
  76
  77     EXIT = 'q'
  78     // The character the user must type to quit the consumer client
  79     // application.
  80   };
  81
  82 protected:
  83   /// the destructor.
  84   ~Consumer_Input_Handler (void);
  85
  86 private:
  87   /// The Consumer_Handler object.
  88   Consumer_Handler *consumer_handler_;
  89 };
  90
  91 #endif /* CONSUMER_INPUT_HANDLER_H */