TAO/orbsvcs/tests/Notify/lib/Periodic_Consumer.h

   1 /* -*- C++ -*- */
   2 /**
   3  *  @file Periodic_Consumer.h
   4  *
   5  *  @author Pradeep Gore <pradeep@oomworks.com>
   6  */
   7
   8 #ifndef TAO_Notify_Tests_PERIODIC_CONSUMER_H
   9 #define TAO_Notify_Tests_PERIODIC_CONSUMER_H
  10 #include /**/ "ace/pre.h"
  11
  12 #include "notify_test_export.h"
  13
  14 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  15 # pragma once
  16 #endif /* ACE_LACKS_PRAGMA_ONCE */
  17
  18 #include "Task_Stats.h"
  19 #include "Notify_StructuredPushConsumer.h"
  20 #include "ace/Arg_Shifter.h"
  21
  22 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  23 class ACE_Barrier;
  24 ACE_END_VERSIONED_NAMESPACE_DECL
  25
  26 class TAO_Notify_Tests_Task_Callback;
  27
  28 /**
  29  * @class TAO_Notify_Tests_Periodic_Consumer
  30  *
  31  * @brief Receives Structured events periodically.
  32  */
  33 class TAO_NOTIFY_TEST_Export TAO_Notify_Tests_Periodic_Consumer : public TAO_Notify_Tests_StructuredPushConsumer
  34 {
  35 public:
  36   /// Constructor
  37   TAO_Notify_Tests_Periodic_Consumer ();
  38
  39   /// Destructor
  40   ~TAO_Notify_Tests_Periodic_Consumer ();
  41
  42   /// set the helper callback
  43   void task_callback(TAO_Notify_Tests_Task_Callback* client);
  44
  45   /// Init the state of this object.
  46   virtual int init_state (ACE_Arg_Shifter& arg_shifter);
  47
  48   /// dump stats
  49   void dump_stats (ACE_TCHAR* msg, int dump_samples);
  50
  51 protected:
  52   virtual void push_structured_event (
  53         const CosNotification::StructuredEvent & notification);
  54
  55   void handle_start_event (const CosNotification::PropertySeq& prop_seq);
  56   void check_priority (const CosNotification::PropertySeq& prop_seq);
  57
  58   /// = Data members.
  59   /// Serialize state.
  60   TAO_SYNCH_MUTEX lock_;
  61
  62   /// count of events received.
  63   int count_;
  64
  65   /// We need to count down these initial events.
  66   int warmup_countdown_;
  67
  68   /// max events expected.
  69   /// Sometimes max count may not be the number of events that the supplier will send.
  70   /// A filter might not allow some events to through. we can tell the consumer what to expect.
  71   int max_count_;
  72
  73   /// The Load
  74   CORBA::ULong load_;
  75
  76   /// Stats house keeping
  77   Task_Stats stats_;
  78
  79   /// Client
  80   TAO_Notify_Tests_Task_Callback* client_;
  81
  82   /// Flag to indicate if we want to check the expected priority.
  83   int check_priority_;
  84
  85   /// This Flag is set if we received an event asking us to "Stop".
  86   int stop_received_;
  87 };
  88
  89 #include /**/ "ace/post.h"
  90 #endif /* TAO_Notify_Tests_PERIODIC_CONSUMER_H */