diff options
Diffstat (limited to 'orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h')
| -rw-r--r-- | orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h | 66 |
1 files changed, 32 insertions, 34 deletions
diff --git a/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h b/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h index cc30861b4f8..3817a8153fb 100644 --- a/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h +++ b/orbsvcs/examples/CosEC/RtEC_Based/lib/EventChannel_i.h @@ -1,22 +1,20 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO services -// -// = FILENAME -// EventChannel_i -// -// = AUTHOR -// Pradeep Gore <pradeep@cs.wustl.edu> -// -// = DESCRIPTION -// This has the implementation of the -// CosEventChannelAdmin::EventChannel interface. -// -// ============================================================================ + +//============================================================================= +/** + * @file EventChannel_i.h + * + * $Id$ + * + * @author Pradeep Gore <pradeep@cs.wustl.edu> + * + * This has the implementation of the + * CosEventChannelAdmin::EventChannel interface. + * + * + */ +//============================================================================= + #ifndef EVENTCHANNEL_I_H #define EVENTCHANNEL_I_H @@ -42,46 +40,46 @@ class TAO_RTEC_COSEC_Export TAO_CosEC_EventChannel_i : // public: // = Initialization and termination methods. + /// Constructor. TAO_CosEC_EventChannel_i (void); - // Constructor. + /// Destructor. ~TAO_CosEC_EventChannel_i (void); - // Destructor. + /// Activates the ConsumerAdmin and SupplierAdmin servants. Returns + /// -1 on error, 0 on success. int init (const RtecEventChannelAdmin::ConsumerQOS &consumerqos, const RtecEventChannelAdmin::SupplierQOS &supplierqos, RtecEventChannelAdmin::EventChannel_ptr rtec); - // Activates the ConsumerAdmin and SupplierAdmin servants. Returns - // -1 on error, 0 on success. + /// The for_consumers method will return the same ConsumerAdmin_ptr + /// everytime its called. virtual CosEventChannelAdmin::ConsumerAdmin_ptr for_consumers (void); - // The for_consumers method will return the same ConsumerAdmin_ptr - // everytime its called. + /// The for_suppliers method will return the same SupplierAdmin_ptr + /// everytime its called. virtual CosEventChannelAdmin::SupplierAdmin_ptr for_suppliers (void); - // The for_suppliers method will return the same SupplierAdmin_ptr - // everytime its called. + /// Destroys this Event Channel object. virtual void destroy (void); - // Destroys this Event Channel object. + /// destroys this Event Channel object and <delete>s this object. void shutdown (void); - // destroys this Event Channel object and <delete>s this object. private: + /// ConsumerAdmin servant object. TAO_CosEC_ConsumerAdmin_i* consumer_admin_; - // ConsumerAdmin servant object. + /// SupplierAdmin servant object. TAO_CosEC_SupplierAdmin_i* supplier_admin_; - // SupplierAdmin servant object. + /// The reference to the ConsumerAdmin interface returned after + /// activating the servant in the ORB. CosEventChannelAdmin::ConsumerAdmin_var consumeradmin_; - // The reference to the ConsumerAdmin interface returned after - // activating the servant in the ORB. + /// The reference to the SupplierAdmin interface returned after + /// activating the servant in the ORB. CosEventChannelAdmin::SupplierAdmin_var supplieradmin_; - // The reference to the SupplierAdmin interface returned after - // activating the servant in the ORB. }; #include /**/ "ace/post.h" |