TAO/orbsvcs/tests/Event/lib/Consumer.h

   1 /* -*- C++ -*- */
   2 //=============================================================================
   3 /**
   4  *  @file   Consumer.h
   5  *
   6  *  @author Carlos O'Ryan (coryan@cs.wustl.edu)
   7  */
   8 //=============================================================================
   9
  10
  11 #ifndef EC_CONSUMER_H
  12 #define EC_CONSUMER_H
  13
  14 #include "Driver.h"
  15
  16 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  17 # pragma once
  18 #endif /* ACE_LACKS_PRAGMA_ONCE */
  19
  20 #include "orbsvcs/RtecEventCommS.h"
  21 #include "orbsvcs/RtecEventChannelAdminC.h"
  22 #include "ace/OS_NS_time.h"
  23 #include "ace/High_Res_Timer.h"
  24
  25 /**
  26  * @class EC_Consumer
  27  *
  28  * @brief Simple consumer object to implement EC tests.
  29  *
  30  * This class is a consumer of events.
  31  * The class is just a helper to simplify common tasks in EC
  32  * tests, such as subscribing for a range of events, disconnecting
  33  * from the EC, informing the driver of shutdown messages, etc.
  34  * There are several ways to connect and disconnect this class,
  35  * and it is up to the driver program to use the right one.
  36  */
  37 class EC_Test_Export EC_Consumer : public POA_RtecEventComm::PushConsumer
  38 {
  39 public:
  40   /// Constructor
  41   EC_Consumer (EC_Driver* driver, void* cookie);
  42
  43   /// The driver program can build the QoS attributes and obtain the
  44   /// ConsumerAdmin, we do the rest.
  45   virtual void connect (
  46       RtecEventChannelAdmin::ConsumerAdmin_ptr consumer_admin,
  47       const RtecEventChannelAdmin::ConsumerQOS& qos,
  48       int shutdown_event_type);
  49
  50   /**
  51    * The driver program can build the QoS attributes and we use
  52    * whatevet supplier_proxy we already have (useful for reconnection
  53    * tests).
  54    */
  55   virtual void connect (
  56       const RtecEventChannelAdmin::ConsumerQOS& qos,
  57       int shutdown_event_type);
  58
  59   /// returns 0 if it is not connected
  60   virtual int connected (void) const;
  61
  62   /// The application can invoke this method to disconnect from the EC
  63   /// and deactivate this class.
  64   void disconnect (void);
  65
  66   /// The application is shutting down, deactivate the consumer.
  67   void shutdown (void);
  68
  69   /// Accumulate our statistics to the totals.
  70   void accumulate (ACE_Throughput_Stats& throughput) const;
  71
  72   /// Printout the statistics
  73   virtual void dump_results (
  74     const ACE_TCHAR* name,
  75     ACE_High_Res_Timer::global_scale_factor_type global_scale_factor);
  76
  77   // = The RtecEventComm::PushConsumer methods
  78
  79   /// The skeleton methods.
  80   virtual void push (const RtecEventComm::EventSet& events);
  81   virtual void disconnect_push_consumer (void);
  82
  83 private:
  84   /// The main driver for the test.
  85   EC_Driver* driver_;
  86
  87   /// A magic cookie passed by the driver that we pass back in our
  88   /// callbacks.
  89   void* cookie_;
  90
  91   /// We talk to the EC using this proxy.
  92   RtecEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_;
  93
  94   /// Protect internal state
  95   TAO_SYNCH_MUTEX lock_;
  96
  97   /// The timestamp for the first message received
  98   ACE_hrtime_t throughput_start_;
  99
 100   /// Used for reporting stats
 101   ACE_Throughput_Stats throughput_;
 102
 103   /// The number of push() calls
 104   int push_count_;
 105
 106   /// The type used to indicate shutdown
 107   int shutdown_event_type_;
 108
 109   /// Is the consumer active in the POA?
 110   int is_active_;
 111
 112   /// Cache the object reference to speed up connect/disconnect calls.
 113   RtecEventComm::PushConsumer_var myself_;
 114 };
 115
 116 #endif /* ECT_CONSUMER_H */