summaryrefslogtreecommitdiff
path: root/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
diff options
context:
space:
mode:
Diffstat (limited to 'orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h')
-rw-r--r--orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h75
1 files changed, 37 insertions, 38 deletions
diff --git a/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h b/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
index c0e7641448b..a4b5d883089 100644
--- a/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
+++ b/orbsvcs/tests/AVStreams/Asynch_Three_Stage/Connection_Manager.h
@@ -1,22 +1,19 @@
-//$Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/orbsvcs/tests/AVStreams/Asynch_Three_Stage
-//
-// = 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>
+ */
+//=============================================================================
+
#include "orbsvcs/Naming/Naming_Client.h"
#include "orbsvcs/AV/AVStreams_i.h"
@@ -30,51 +27,53 @@ class Endpoint_Addresses
ACE_CString receiver_addr;
};
+/**
+ * @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 (AVStreams::MMDevice_ptr sender);
- // 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 all streams.
void destroy (void);
- // Destroy all streams.
+ /// Destroy streams associated with <flowname>.
void destroy (const ACE_CString &flowname);
- // Destroy streams associated with <flowname>.
+ /// 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,
@@ -117,8 +116,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_;