ChangeLogTag:Wed Nov 1 14:11:48 2000 Carlos O'Ryan <coryan@uci.edu>

1 files changed, 77 insertions, 67 deletions

diff --git a/ace/SOCK_Dgram.h b/ace/SOCK_Dgram.h
index 567d5d34142..969fd7f42cd 100644
--- a/ace/SOCK_Dgram.h
+++ b/ace/SOCK_Dgram.h
@@ -1,18 +1,15 @@
 /* -*- C++ -*- */
-// $Id$
-
-// ===========================================================================
-//
-// = LIBRARY
-//    ace
-//
-// = FILENAME
-//    SOCK_Dgram.h
-//
-// = AUTHOR
-//    Doug Schmidt
-//
-// ===========================================================================
+
+//=============================================================================
+/**
+ *  @file    SOCK_Dgram.h
+ *
+ *  $Id$
+ *
+ *  @author Doug Schmidt
+ */
+//=============================================================================
+
 
 #ifndef ACE_SOCK_DGRAM_H
 #define ACE_SOCK_DGRAM_H
@@ -26,23 +23,31 @@
 
 #include "ace/Addr.h"
 
+/**
+ * @class ACE_SOCK_Dgram
+ *
+ * @brief Defines the member functions for the ACE_SOCK datagram
+ * abstraction.
+ */
 class ACE_Export ACE_SOCK_Dgram : public ACE_SOCK
 {
-  // = TITLE
-  //     Defines the member functions for the ACE_SOCK datagram
-  //     abstraction.
 public:
   // = Initialization and termination methods.
+  /// Default constructor.
   ACE_SOCK_Dgram (void);
-  // Default constructor.
 
+  /// This is a BSD-style method (i.e., no QoS) for initiating a socket
+  /// dgram that will accept datagrams at the <local> address.
   ACE_SOCK_Dgram (const ACE_Addr &local,
                   int protocol_family = PF_INET,
                   int protocol = 0,
                   int reuse_addr = 0);
-  // This is a BSD-style method (i.e., no QoS) for initiating a socket
-  // dgram that will accept datagrams at the <local> address.
 
+  /**
+   * This is a QoS-enabed method for initiating a socket dgram that
+   * will accept datagrams at the <local> address.  The <qos_params>
+   * are passed to <ACE_OS::join_leaf>.
+   */
   ACE_SOCK_Dgram (const ACE_Addr &local,
                   int protocol_family,
                   int protocol,
@@ -50,17 +55,19 @@ public:
                   ACE_SOCK_GROUP g = 0,
                   u_long flags = 0,
                   int reuse_addr = 0);
-  // This is a QoS-enabed method for initiating a socket dgram that
-  // will accept datagrams at the <local> address.  The <qos_params>
-  // are passed to <ACE_OS::join_leaf>.
 
+  /// This is a BSD-style method (i.e., no QoS) for initiating a socket
+  /// dgram that will accept datagrams at the <local> address.
   int open (const ACE_Addr &local,
             int protocol_family = PF_INET,
             int protocol = 0,
             int reuse_addr = 0);
-  // This is a BSD-style method (i.e., no QoS) for initiating a socket
-  // dgram that will accept datagrams at the <local> address.
 
+  /**
+   * This is a QoS-enabed method for initiating a socket dgram that
+   * will accept datagrams at the <local> address.  The <qos_params>
+   * are passed to <ACE_OS::join_leaf>.
+   */
   int open (const ACE_Addr &local,
             int protocol_family,
             int protocol,
@@ -68,78 +75,83 @@ public:
             ACE_SOCK_GROUP g = 0,
             u_long flags = 0,
             int reuse_addr = 0);
-  // This is a QoS-enabed method for initiating a socket dgram that
-  // will accept datagrams at the <local> address.  The <qos_params>
-  // are passed to <ACE_OS::join_leaf>.
 
+  /// Default dtor.
   ~ACE_SOCK_Dgram (void);
-  // Default dtor.
 
   // = Data transfer routines.
+  /// Send an <n> byte <buf> to the datagram socket (uses <sendto(3)>).
   ssize_t send (const void *buf,
                 size_t n,
                 const ACE_Addr &addr,
                 int flags = 0) const;
-  // Send an <n> byte <buf> to the datagram socket (uses <sendto(3)>).
 
+  /// Receive an <n> byte <buf> from the datagram socket (uses
+  /// <recvfrom(3)>).
   ssize_t recv (void *buf,
                 size_t n,
                 ACE_Addr &addr,
                 int flags = 0) const;
-  // Receive an <n> byte <buf> from the datagram socket (uses
-  // <recvfrom(3)>).
 
+  /**
+   * Allows a client to read from a socket without having to provide a
+   * buffer to read.  This method determines how much data is in the
+   * socket, allocates a buffer of this size, reads in the data, and
+   * returns the number of bytes read.  The caller is responsible for
+   * deleting the member in the <iov_base> field of <io_vec> using the
+   * ``delete []'' syntax.
+   */
   ssize_t recv (iovec *io_vec,
                 ACE_Addr &addr,
                 int flags = 0,
                 const ACE_Time_Value *timeout = 0) const;
-  // Allows a client to read from a socket without having to provide a
-  // buffer to read.  This method determines how much data is in the
-  // socket, allocates a buffer of this size, reads in the data, and
-  // returns the number of bytes read.  The caller is responsible for
-  // deleting the member in the <iov_base> field of <io_vec> using the
-  // ``delete []'' syntax.
 
+  /// Send an <iovec> of size <n> to the datagram socket (uses
+  /// <sendmsg(3)>).
   ssize_t send (const iovec iov[],
                 size_t n,
                 const ACE_Addr &addr,
                 int flags = 0) const;
-  // Send an <iovec> of size <n> to the datagram socket (uses
-  // <sendmsg(3)>).
 
+  /// Recv an <iovec> of size <n> to the datagram socket (uses
+  /// <recvmsg(3)>).
   ssize_t recv (iovec iov[],
                 size_t n,
                 ACE_Addr &addr,
                 int flags = 0) const;
-  // Recv an <iovec> of size <n> to the datagram socket (uses
-  // <recvmsg(3)>).
 
+  /**
+   * Wait up to <timeout> amount of time to receive a datagram into
+   * <buf>.  The <ACE_Time_Value> indicates how long to blocking
+   * trying to receive.  If <timeout> == 0, the caller will block
+   * until action is possible, else will wait until the relative time
+   * specified in *<timeout> elapses).  If <recv> times out a -1 is
+   * returned with <errno == ETIME>.  If it succeeds the number of
+   * bytes received is returned.
+   */
   ssize_t recv (void *buf,
                 size_t n,
                 ACE_Addr &addr,
                 int flags,
                 const ACE_Time_Value *timeout) const;
-  // Wait up to <timeout> amount of time to receive a datagram into
-  // <buf>.  The <ACE_Time_Value> indicates how long to blocking
-  // trying to receive.  If <timeout> == 0, the caller will block
-  // until action is possible, else will wait until the relative time
-  // specified in *<timeout> elapses).  If <recv> times out a -1 is
-  // returned with <errno == ETIME>.  If it succeeds the number of
-  // bytes received is returned.
 
+  /**
+   * Wait up to <timeout> amount of time to receive a datagram into
+   * <buf>.  The <ACE_Time_Value> indicates how long to blocking
+   * trying to receive.  If <timeout> == 0, the caller will block
+   * until action is possible, else will wait until the relative time
+   * specified in *<timeout> elapses).  If <send> times out a -1 is
+   * returned with <errno == ETIME>.  If it succeeds the number of
+   * bytes received is returned.
+   */
   ssize_t send (const void *buf,
                 size_t n,
                 ACE_Addr &addr,
                 int flags,
                 const ACE_Time_Value *timeout) const;
-  // Wait up to <timeout> amount of time to receive a datagram into
-  // <buf>.  The <ACE_Time_Value> indicates how long to blocking
-  // trying to receive.  If <timeout> == 0, the caller will block
-  // until action is possible, else will wait until the relative time
-  // specified in *<timeout> elapses).  If <send> times out a -1 is
-  // returned with <errno == ETIME>.  If it succeeds the number of
-  // bytes received is returned.
 
+  /// Send <buffer_count> worth of <buffers> to <addr> using overlapped
+  /// I/O (uses <WSASentTo>).  Returns 0 on success.
   ssize_t send (const iovec buffers[],
                 int buffer_count,
                 size_t &number_of_bytes_sent,
@@ -147,9 +159,9 @@ public:
                 const ACE_Addr &addr,
                 ACE_OVERLAPPED *overlapped,
                 ACE_OVERLAPPED_COMPLETION_FUNC func) const;
-  // Send <buffer_count> worth of <buffers> to <addr> using overlapped
-  // I/O (uses <WSASentTo>).  Returns 0 on success.
 
+  /// Recv <buffer_count> worth of <buffers> from <addr> using
+  /// overlapped I/O (uses <WSARecvFrom>).  Returns 0 on success.
   ssize_t recv (iovec buffers[],
                 int buffer_count,
                 size_t &number_of_bytes_recvd,
@@ -157,40 +169,38 @@ public:
                 ACE_Addr &addr,
                 ACE_OVERLAPPED *overlapped,
                 ACE_OVERLAPPED_COMPLETION_FUNC func) const;
-  // Recv <buffer_count> worth of <buffers> from <addr> using
-  // overlapped I/O (uses <WSARecvFrom>).  Returns 0 on success.
 
+  /// Send an <n> byte <buf> to the datagram socket (uses <WSASentTo>).
   ssize_t send (const void *buf,
                 size_t n,
                 const ACE_Addr &addr,
                 int flags,
                 ACE_OVERLAPPED *overlapped,
                 ACE_OVERLAPPED_COMPLETION_FUNC func) const;
-  // Send an <n> byte <buf> to the datagram socket (uses <WSASentTo>).
 
+  /// Receive an <n> byte <buf> from the datagram socket (uses
+  /// <WSARecvFrom>).
   ssize_t recv (void *buf,
                 size_t n,
                 ACE_Addr &addr,
                 int flags,
                 ACE_OVERLAPPED *overlapped,
                 ACE_OVERLAPPED_COMPLETION_FUNC func) const;
-  // Receive an <n> byte <buf> from the datagram socket (uses
-  // <WSARecvFrom>).
 
+  /// Dump the state of an object.
   void dump (void) const;
-  // Dump the state of an object.
 
+  /// Declare the dynamic allocation hooks.
   ACE_ALLOC_HOOK_DECLARE;
-  // Declare the dynamic allocation hooks.
 
 protected:
+  /// Open is shared by this and by <LSOCK_Dgram>.
   int shared_open (const ACE_Addr &local,
                    int protocol_family);
-  // Open is shared by this and by <LSOCK_Dgram>.
 
 private:
+  /// Do not allow this function to percolate up to this interface...
   int  get_remote_addr (ACE_Addr &) const;
-  // Do not allow this function to percolate up to this interface...
 };
 
 #if !defined (ACE_LACKS_INLINE_FUNCTIONS)