diff options
Diffstat (limited to 'orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h')
| -rw-r--r-- | orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h | 61 |
1 files changed, 32 insertions, 29 deletions
diff --git a/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h b/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h index 7466073ed0f..4343aaef780 100644 --- a/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/Consumer.h +++ b/orbsvcs/examples/CosEC/RtEC_Based/tests/Basic/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_ @@ -22,45 +23,47 @@ #include "orbsvcs/CosEventCommS.h" #include "orbsvcs/CosEventChannelAdminS.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 { - // = TITLE - // Consumer - // - // = DESCRIPTION - // The Consumer is a simple PushConsumer that connects to the - // CosEC and receives events from it. public: + /// This method connects the consumer to the EC. void open (CosEventChannelAdmin::EventChannel_ptr event_channel, CORBA::ORB_ptr orb); - // 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. private: + /// The orb that we as using. CORBA::ORB_var orb_; - // The orb that we as using. + /// 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. }; #endif /* COSECCONSUMER_H_ */ |