diff options
Diffstat (limited to 'examples/Simulator/Event_Supplier/DOVE_Supplier.h')
| -rw-r--r-- | examples/Simulator/Event_Supplier/DOVE_Supplier.h | 61 |
1 files changed, 30 insertions, 31 deletions
diff --git a/examples/Simulator/Event_Supplier/DOVE_Supplier.h b/examples/Simulator/Event_Supplier/DOVE_Supplier.h index 4061b552e55..68730f98e1d 100644 --- a/examples/Simulator/Event_Supplier/DOVE_Supplier.h +++ b/examples/Simulator/Event_Supplier/DOVE_Supplier.h @@ -1,25 +1,24 @@ -// $Id$ - -// ============================================================================ -// -// = FILENAME -// DOVE_Supplier.h -// -// = DESCRIPTION -// A wrapper around the event service initialization and marshalling. -// -// = AUTHORS -// Michael Kircher (mk1@cs.wustl.edu) -// Chris Gill (cdgill@cs.wustl.edu) -// ============================================================================ - -#include "ace/OS.h" + +//============================================================================= +/** + * @file DOVE_Supplier.h + * + * $Id$ + * + * A wrapper around the event service initialization and marshalling. + * + * + * @author Michael Kircher (mk1@cs.wustl.edu) Chris Gill (cdgill@cs.wustl.edu) + */ +//============================================================================= + + +#include "orbsvcs/RtecEventChannelAdminC.h" #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ -#include "orbsvcs/RtecEventChannelAdminC.h" #include "orbsvcs/RtecEventCommS.h" #include "orbsvcs/Event_Utilities.h" #include "orbsvcs/Event_Service_Constants.h" @@ -35,35 +34,35 @@ class DOVE_Supplier { public: + /// Constructor. DOVE_Supplier (); - // Constructor. + /// Destructor. ~DOVE_Supplier (void); - // Destructor. + /// Initialize the ORB and the connection to the Name Service int init (void); - // Initialize the ORB and the connection to the Name Service + /// Connect to the event service. int connect (const char * MIB_name = 0, const char* es_name = 0, const char * ss_name = 0, ACE_Scheduler_Factory::POD_RT_Info * pod_rt_info = 0); - // Connect to the event service. + /// Perform all post-connection-establishment processing. void connected (); - // Perform all post-connection-establishment processing. + /// Disconnect from the event service. void disconnect (); - // Disconnect from the event service. + /// Notify the consumer proxy that we have events void notify (CORBA::Any& message); - // Notify the consumer proxy that we have events + /// Use the next connection in the list of established connections. void use_next_connection (); - // Use the next connection in the list of established connections. + /// Use the previous connection in the list of established connections. void use_prev_connection (); - // Use the previous connection in the list of established connections. private: @@ -101,17 +100,17 @@ private: ACE_Scheduler_Factory::POD_RT_Info pod_rt_info_; }; + /// Get the event channel reference. int get_EventChannel (); - // Get the event channel reference. + /// Get the scheduler reference. int get_Scheduler (); - // Get the scheduler reference. + /// Connect the the supplier with the event channel. int connect_Supplier (); - // Connect the the supplier with the event channel. + /// Access the default rt_info singleton. static ACE_Scheduler_Factory::POD_RT_Info * pod_rt_info_instance (); - // Access the default rt_info singleton. static ACE_Scheduler_Factory::POD_RT_Info * pod_rt_info_instance_; @@ -131,8 +130,8 @@ private: Internal_DOVE_Supplier* internal_DOVE_Supplier_ptr_; + /// Keep the name of the MIB around. const char * MIB_name_; - // Keep the name of the MIB around. }; #endif /* DOVE_SUPPLIER_H */ |