ChangeLogTag:Mon Oct 09 16:45:00 2000 Carlos O'Ryan <coryan@uci.edu>

1 files changed, 26 insertions, 12 deletions

diff --git a/protocols/ace/RMCast/RMCast_UDP_Proxy.h b/protocols/ace/RMCast/RMCast_UDP_Proxy.h
index 02d4e3409a9..f1a7f77a25a 100644
--- a/protocols/ace/RMCast/RMCast_UDP_Proxy.h
+++ b/protocols/ace/RMCast/RMCast_UDP_Proxy.h
@@ -28,28 +28,41 @@
 
 class ACE_RMCast_IO_UDP;
 
+/// Define the proxy implementation for UDP based communication
+/**
+ * Proxy objects are transport specific, they are responsible for
+ * storing the remote peer addressing information.
+ * This class implements the UDP version of a proxy.
+ */
 class ACE_RMCast_Export ACE_RMCast_UDP_Proxy : public ACE_RMCast_Proxy
 {
-  // = TITLE
-  //     Proxy for UDP-based RMCast
-  //
-  // = DESCRIPTION
-  //
 public:
+  /// Constructor
+  /**
+   * The \param io_udp argument is kept to send the replys through the
+   * right socket.
+   * The \param peer_addr is the address used byu the peer to receive
+   * responses.
+   */
   ACE_RMCast_UDP_Proxy (ACE_RMCast_IO_UDP *io_udp,
                         const ACE_INET_Addr &peer_addr);
-  // Constructor
 
+  /// Destructor
   virtual ~ACE_RMCast_UDP_Proxy (void);
-  // Destructor
 
+  /// Receive a message, parse and send it upstream in the right
+  /// format.
   int receive_message (char *buffer, size_t size);
-  // Receive the message
 
+  /// Make the peer address available
   const ACE_INET_Addr &peer_addr (void) const;
-  // The address of the peer
 
-  // = The ACE_RMCast_Proxy methods
+  //@{
+  /**
+   * Implement the ACE_RMCast_Proxy methods, in this case we use the
+   * \param io_udp_ object to send the data, using the address of our
+   * remote peer.
+   */
   virtual int reply_data (ACE_RMCast::Data &);
   virtual int reply_poll (ACE_RMCast::Poll &);
   virtual int reply_ack_join (ACE_RMCast::Ack_Join &);
@@ -57,13 +70,14 @@ public:
   virtual int reply_ack (ACE_RMCast::Ack &);
   virtual int reply_join (ACE_RMCast::Join &);
   virtual int reply_leave (ACE_RMCast::Leave &);
+  //@}
 
 private:
+  /// The IO facade
   ACE_RMCast_IO_UDP *io_udp_;
-  // The IO facade
 
+  /// The remote peer's address
   ACE_INET_Addr peer_addr_;
-  // The address of the peer
 };
 
 #if defined (__ACE_INLINE__)