TAO/docs/tutorials/Quoter/RTCORBA/StockNameConsumer_i.h

   1 /**
   2  * @file StockNameConsumer_i.h
   3  *
   4  * @author Shanshan Jiang <shanshan.jiang@vanderbilt.edu>
   5  * @author William R. Otte <wotte@dre.vanderbilt.edu>
   6  * @author Douglas C. Schmidt <schmidt@dre.vanderbilt.edu>
   7  */
   8
   9 #ifndef STOCKNAMECONSUMER_I_H_
  10 #define STOCKNAMECONSUMER_I_H_
  11
  12 // local headers
  13 #include "CommonS.h"
  14 #include "BrokerS.h"
  15
  16 // TAO headers
  17 #include "tao/RTCORBA/RTCORBA.h"
  18
  19 // STL headers
  20 #include <string>
  21
  22 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  23 #pragma once
  24 #endif /* ACE_LACKS_PRAGMA_ONCE */
  25
  26 // Forward declaration
  27 class Stock_StockBroker_i;
  28
  29 /**
  30  * @class Stock_StockNameConsumer_i
  31  * @brief This class is used as a callback interface used by the
  32  * distributor to notify brokers of updates. This class is ALSO used as a
  33  * signal handler to catch SIGINT and properly unsubscribe from the
  34  * distributor.
  35  */
  36 class  Stock_StockNameConsumer_i :
  37   public virtual POA_Stock::StockNameConsumer
  38 {
  39 public:
  40   /**
  41    * Constructor.
  42    *
  43    * @param parent The parent StockBroker object reference of the StockNameConsumer object.
  44    * @param stock_name The name of the stock that the parent StockBroker object need to listen to.
  45    */
  46   Stock_StockNameConsumer_i (Stock_StockBroker_i  &context,
  47                              const char *stock_name);
  48
  49   /// Destructor.
  50   virtual ~Stock_StockNameConsumer_i (void);
  51
  52   /**
  53    * Push an event to the consumer.
  54    *
  55    * @param the_stockname The name of the stock that will be provided to the context StockBroker object.
  56    */
  57   virtual void push_StockName (::Stock::StockNames *the_stockname);
  58
  59   /**
  60    * Get the cookie attribute.
  61    *
  62    * @return The cookie attribute.
  63    */
  64   virtual ::Stock::Cookie * cookie_ ();
  65
  66   /**
  67    * Set the cookie attribute.
  68    *
  69    * @param cookie The value of cookie attribute that need to be set.
  70    */
  71   virtual void cookie_ (::Stock::Cookie *cookie);
  72
  73 private:
  74   /// Context of the StockNameConsumer object.
  75   Stock_StockBroker_i &context_;
  76
  77   /// Name of the stock to listen to.
  78   CORBA::String_var stock_name_;
  79
  80   Stock::Cookie_var cookie__;
  81 };
  82
  83 #endif /*  STOCKNAMECONSUMER_I_H_ */