diff options
Diffstat (limited to 'orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h')
-rw-r--r-- | orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h | 77 |
1 files changed, 38 insertions, 39 deletions
diff --git a/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h b/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h index 0e0547a14b4..d4ea1ef6e15 100644 --- a/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h +++ b/orbsvcs/tests/AVStreams/Component_Switching/Connection_Manager.h @@ -1,22 +1,19 @@ -//$Id$ - -// ============================================================================ -// -// = LIBRARY -// TAO/orbsvcs/tests/AVStreams/Component_Switching -// -// = FILENAME -// Connection_Manager.h -// -// = DESCRIPTION -// This is a helper class that allows the senders bind to multiple -// receivers and receivers to bind to senders. It also lets the -// senders and receivers disconnect streams. -// -// = AUTHOR -// Yamuna Krishnamurthy <yamuna@cs.wustl.edu> -// -// ============================================================================ + +//============================================================================= +/** + * @file Connection_Manager.h + * + * $Id$ + * + * This is a helper class that allows the senders bind to multiple + * receivers and receivers to bind to senders. It also lets the + * senders and receivers disconnect streams. + * + * + * @author Yamuna Krishnamurthy <yamuna@cs.wustl.edu> + */ +//============================================================================= + #ifndef CONNECTION_MANAGER_H #define CONNECTION_MANAGER_H @@ -26,57 +23,59 @@ #include "orbsvcs/AV/Protocol_Factory.h" #include "tao/PortableServer/PortableServer.h" +/** + * @class Connection_Manager + * + * @brief Defines the Connection Manager. + * + * This is a helper class that allows the senders bind to + * multiple receivers and receivers to bind to senders. It also + * lets the senders and receivers disconnect streams. + */ class Connection_Manager { - // = TITLE - // Defines the Connection Manager. - // - // = DESCRIPTION - // This is a helper class that allows the senders bind to - // multiple receivers and receivers to bind to senders. It also - // lets the senders and receivers disconnect streams. public: + /// Constructor Connection_Manager (void); - // Constructor + /// Destructor ~Connection_Manager (void); - // Destructor + /// Initialize this class. int init (CORBA::ORB_ptr orb); - // Initialize this class. + /// Method that binds the sender to the Naming Service and retreives + /// the references of any registered receivers. void bind_to_receivers (const ACE_CString &sender_name, AVStreams::MMDevice_ptr sender); - // Method that binds the sender to the Naming Service and retreives - // the references of any registered receivers. + /// Connect to the receivers that we found. void connect_to_receivers (void); - // Connect to the receivers that we found. + /// Bind receiver to the sender. void bind_to_sender (const ACE_CString &sender_name, const ACE_CString &receiver_name, AVStreams::MMDevice_ptr receiver); - // Bind receiver to the sender. + /// Connect to the sender that we found. void connect_to_sender (void); - // Connect to the sender that we found. + /// Destroy streams associated with <flowname>. void destroy (const ACE_CString &flowname); - // Destroy streams associated with <flowname>. + /// Unbind the sender from the Naming Service void unbind_sender (const ACE_CString &sender_name, AVStreams::MMDevice_ptr sender_mmdevice) ; - // Unbind the sender from the Naming Service + /// Unbind the Receiver from the Naming Service void unbind_receiver (const ACE_CString &sender_name, const ACE_CString &receiver_name, AVStreams::MMDevice_ptr receiver_mmdevice); - // Unbind the Receiver from the Naming Service + /// Add new streamctrl. void add_streamctrl (const ACE_CString &flowname, TAO_StreamEndPoint *endpoint); - // Add new streamctrl. // Map of receivers. typedef ACE_Hash_Map_Manager<ACE_CString, @@ -107,8 +106,8 @@ protected: void add_to_receivers (CosNaming::BindingList &binding_list); + /// The Naming Service client. TAO_Naming_Client naming_client_; - // The Naming Service client. // The maps. Receivers receivers_; |