summaryrefslogtreecommitdiff
path: root/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
diff options
context:
space:
mode:
Diffstat (limited to 'orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h')
-rw-r--r--orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h69
1 files changed, 36 insertions, 33 deletions
diff --git a/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h b/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
index 2f70d238fb2..741df7d2ea5 100644
--- a/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
+++ b/orbsvcs/examples/CosEC/RtEC_Based/tests/Multiple/Consumer.h
@@ -1,18 +1,19 @@
/* -*- C++ -*- */
-// $Id$
-
-// ============================================================================
-//
-// = FILENAME
-// Consumer.h
-//
-// = AUTHOR
-// Pradeep Gore <pradeep@cs.wustl.edu>
-//
-// = DESCRIPTION
-// Defines a simple Push Consumer.
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Consumer.h
+ *
+ * $Id$
+ *
+ * @author Pradeep Gore <pradeep@cs.wustl.edu>
+ *
+ * Defines a simple Push Consumer.
+ *
+ *
+ */
+//=============================================================================
+
#ifndef COSECCONSUMER_H_
#define COSECCONSUMER_H_
@@ -23,55 +24,57 @@
#include "orbsvcs/CosEventChannelAdminS.h"
#include "Multiple.h"
+/**
+ * @class Consumer
+ *
+ * @brief Consumer
+ *
+ * The Consumer is a simple PushConsumer that connects to the
+ * CosEC and receives events from it.
+ */
class Consumer : public POA_CosEventComm::PushConsumer, public Multiple
{
- // = TITLE
- // Consumer
- //
- // = DESCRIPTION
- // The Consumer is a simple PushConsumer that connects to the
- // CosEC and receives events from it.
public:
// = Initializatiopn and termination methods.
+ /// Constructor.
Consumer ();
- // Constructor.
+ /// Initialize the Consumer.
int init_Consumer (void);
- // Initialize the Consumer.
+ /// This method connects the consumer to the EC.
void open (CosEventChannelAdmin::EventChannel_ptr event_channel);
- // This method connects the consumer to the EC.
+ /// Disconnect from the EC.
void close (void);
- // Disconnect from the EC.
+ /// Connect the Consumer to the EventChannel.
void connect (void);
- // Connect the Consumer to the EventChannel.
+ /// Disconnect from the supplier, but do not forget about it or close
+ /// it.
void disconnect (void);
- // Disconnect from the supplier, but do not forget about it or close
- // it.
+ /// push the event to the consumer.
virtual void push (const CORBA::Any &data);
- // push the event to the consumer.
+ /// disconnect the consumer from the EC.
virtual void disconnect_push_consumer (void);
- // disconnect the consumer from the EC.
// = CosEC_Multiple methods.
+ /// Parse the command line options.
virtual int parse_args (int argc, ACE_TCHAR *argv []);
- // Parse the command line options.
private:
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ProxyPushSupplier_var supplier_proxy_;
- // We talk to the EC using this proxy.
+ /// We talk to the EC using this proxy.
CosEventChannelAdmin::ConsumerAdmin_var consumer_admin_;
- // We talk to the EC using this proxy.
+ /// The number of Events to receive before switching off.
int event_count_;
- // The number of Events to receive before switching off.
};
#endif /* COSECCONSUMER_H_ */