TAO/docs/tutorials/Quoter/RTCORBA/Common.idl

   1 /**
   2  * @file Common.idl
   3  * @author Shanshan Jiang <shanshan.jiang@vanderbilt.edu>
   4  * @author William R. Otte <wotte@dre.vanderbilt.edu>
   5  * @author Douglas C. Schmidt <schmidt@dre.vanderbilt.edu>
   6
   7  *
   8  * Contains common IDL definitions in the Publish/Subscribe Real-time CORBA
   9  * Stock Quoter Service.
  10  */
  11
  12 #ifndef QUOTER_COMMON_IDL
  13 #define QUOTER_COMMON_IDL
  14
  15 #include "tao/StringSeq.pidl"
  16
  17 module Stock
  18 {
  19   exception Invalid_Stock
  20   {
  21   };
  22
  23   /// Contains information about a single stock.
  24   struct StockInfo
  25   {
  26     string name;
  27     long high;
  28     long low;
  29     long last;
  30   };
  31
  32   /// Used to communicate an available update.
  33   valuetype StockNames
  34   {
  35     public CORBA::StringSeq names;
  36   };
  37
  38   valuetype Cookie
  39   {
  40     public string cookie_id;
  41   };
  42
  43   interface Trigger
  44   {
  45     void start ();
  46     void stop ();
  47   };
  48
  49   /**
  50    * @class StockNameConsumer
  51    * @brief Callback interface used by the distributor to notify brokers of updates.
  52    */
  53   interface StockNameConsumer
  54   {
  55     void push_StockName (in StockNames the_stocknames);
  56
  57     attribute Cookie cookie_;
  58   };
  59
  60   /**
  61    * @class StockQuoter
  62    * @brief Provides an interface for brokers to get detailed stock information.
  63    */
  64   interface StockQuoter
  65   {
  66     /// Returns detailed stock information to brokers.
  67     /// @param stockname A valid name for a stock.
  68     /// @returns Completed stockinfo struct.
  69     StockInfo get_stock_info (in string stock_name) raises (Invalid_Stock);
  70   };
  71 };
  72
  73 #endif