/* -*- C++ -*- */
// Consumer.h,v 1.11 2002/01/29 20:20:54 okellogg Exp
//
// ============================================================================
//
// = LIBRARY
//   ORBSVCS Real-time Event Channel testsuite
//
// = FILENAME
//   Consumer
//
// = AUTHOR
//   Carlos O'Ryan (coryan@cs.wustl.edu)
//
// ============================================================================

#ifndef EC_CONSUMER_H
#define EC_CONSUMER_H

#include "Driver.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "orbsvcs/RtecEventCommS.h"
#include "orbsvcs/RtecEventChannelAdminC.h"

class EC_Test_Export EC_Consumer : public POA_RtecEventComm::PushConsumer
{
  // = TITLE
  //   Simple consumer object to implement EC tests.
  //
  // = DESCRIPTION
  //   This class is a consumer of events.
  //   The class is just a helper to simplify common tasks in EC
  //   tests, such as subscribing for a range of events, disconnecting
  //   from the EC, informing the driver of shutdown messages, etc.
  //
  //   There are several ways to connect and disconnect this class,
  //   and it is up to the driver program to use the right one.
  //
public:
  EC_Consumer (EC_Driver* driver, void* cookie);
  // Constructor

  virtual void connect (
      RtecEventChannelAdmin::ConsumerAdmin_ptr consumer_admin,
      const RtecEventChannelAdmin::ConsumerQOS& qos,
      int shutdown_event_type
      ACE_ENV_ARG_DECL);
  // The driver program can build the QoS attributes and obtain the
  // ConsumerAdmin, we do the rest.

  virtual void connect (
      const RtecEventChannelAdmin::ConsumerQOS& qos,
      int shutdown_event_type
      ACE_ENV_ARG_DECL);
  // The driver program can build the QoS attributes and we use
  // whatevet supplier_proxy we already have (useful for reconnection
  // tests).

  virtual int connected (void) const;
  // returns 0 if it is not connected

  void disconnect (ACE_ENV_SINGLE_ARG_DECL);
  // The application can invoke this method to disconnect from the EC
  // and deactivate this class.

  void shutdown (ACE_ENV_SINGLE_ARG_DECL);
  // The application is shutting down, deactivate the consumer.

  void accumulate (ACE_Throughput_Stats& throughput) const;
  // Accumulate our statistics to the totals.

  virtual void dump_results (const char* name,
                             ACE_UINT32 global_scale_factor);
  // Printout the statistics

  // = The RtecEventComm::PushConsumer methods

  virtual void push (const RtecEventComm::EventSet& events
                     ACE_ENV_ARG_DECL)
    ACE_THROW_SPEC ((CORBA::SystemException));
  virtual void disconnect_push_consumer (ACE_ENV_SINGLE_ARG_DECL_NOT_USED)
    ACE_THROW_SPEC ((CORBA::SystemException));
  // The skeleton methods.

private:
  EC_Driver* driver_;
  // The main driver for the test.

  void* cookie_;
  // A magic cookie passed by the driver that we pass back in our
  // callbacks.

  RtecEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_;
  // We talk to the EC using this proxy.

  TAO_SYNCH_MUTEX lock_;
  // Protect internal state

  ACE_hrtime_t throughput_start_;
  // The timestamp for the first message received

  ACE_Throughput_Stats throughput_;
  // Used for reporting stats

  int push_count_;
  // The number of push() calls

  int shutdown_event_type_;
  // The type used to indicate shutdown

  int is_active_;
  // Is the consumer active in the POA?

  RtecEventComm::PushConsumer_var myself_;
  // Cache the object reference to speed up connect/disconnect calls.
};

#endif /* ECT_CONSUMER_H */
