ChangeLogTag:Mon Sep 17 13:18:35 2001 Carlos O'Ryan <coryan@uci.edu>

1 files changed, 46 insertions, 18 deletions

diff --git a/TAO/orbsvcs/orbsvcs/RtecUDPAdmin.idl b/TAO/orbsvcs/orbsvcs/RtecUDPAdmin.idl
index 68525f07d2d..b63f52fe9a2 100644
--- a/TAO/orbsvcs/orbsvcs/RtecUDPAdmin.idl
+++ b/TAO/orbsvcs/orbsvcs/RtecUDPAdmin.idl
@@ -1,33 +1,61 @@
-// $Id$
+/**
+ * @file RtecUDPAdmin.idl
+ *
+ * @brief Define the RtecUDPAdmin module
+ *
+ * $Id$
+ *
+ * TAO's Real-time Event Service is described in:
+ *
+ * http://doc.ece.uci.edu/~coryan/EC/
+ *
+ * @author Carlos O'Ryan <coryan@uci.edu>
+ */
 
 #ifndef TAO_RTEC_UDP_ADMIN_IDL
 #define TAO_RTEC_UDP_ADMIN_IDL
 
 #include "RtecEventComm.idl"
 
-module RtecUDPAdmin 
+/**
+ * @namespace RtecUDPAdmin
+ *
+ * @brief Define the data structures and interfaces used by UDP-based
+ *   gateways
+ */
+module RtecUDPAdmin
 {
-  // = TITLE
-  //   Multicast Administration module
-  //
-  // = DESCRIPTION
-  //   When the EC is used as an interface to multicast communication
-  //   a mapping between event types and multicast addresses must be
-  //   stablished.
-
-  struct UDP_Addr 
+  /**
+   * @struct UDP_Addr
+   *
+   * @brief Represent a UDP SAP.
+   */
+  struct UDP_Addr
   {
+    /// The IP address
     unsigned long ipaddr;
+    /// The UDP port
     unsigned short port;
   };
 
-  interface AddrServer 
-    {
-      void get_addr (in RtecEventComm::EventHeader header,
-                     out UDP_Addr addr);
-      // Get the addr and port given the event header.
-    };
-
+  /**
+   * @interface AddrServer
+   *
+   * @brief Defines a interface to configure the mapping between
+   *   events and multicast groups (or UDP broadcast or UDP unicast)
+   *   addresses.
+   */
+  interface AddrServer
+  {
+    /// Get the UDP address give the event header
+    /**
+     * @param header The event header, used to fetch the type and
+     *   source of the event
+     * @param addr Return the address used for the given event type
+     */
+    void get_addr (in RtecEventComm::EventHeader header,
+                   out UDP_Addr addr);
+  };
 };
 
 #endif /* TAO_RTEC_UDP_ADMIN_IDL */