]> git.proxmox.com Git - mirror_edk2.git/blobdiff - StdLib/BsdSocketLib/recv.c
Add missing IPv6 address definitions.
[mirror_edk2.git] / StdLib / BsdSocketLib / recv.c
index 735e1dbddd1a657e7233e4f7f6c47a7d85dd969e..0ad7252c4490909a8ce4b9f82113acc4a63d6cf3 100644 (file)
 /**\r
   Receive data from a network connection.\r
 \r
-  The ::recv routine waits for receive data from a remote network\r
-  connection.  The\r
+  The recv routine waits for receive data from a remote network\r
+  connection.  This routine is typically used for SOCK_STREAM\r
+  because it waits for receive data from the target system specified\r
+  in the ::connect call.\r
+\r
+  The\r
   <a href="http://pubs.opengroup.org/onlinepubs/9699919799/functions/recv.html">POSIX</a>\r
   documentation is available online.\r
 \r
   @param [in] s         Socket file descriptor returned from ::socket.\r
 \r
   @param [in] buffer    Address of a buffer to receive the data.\r
-  \r
+\r
   @param [in] length    Length of the buffer in bytes.\r
 \r
   @param [in] flags     Message control flags\r
 \r
-  @returns    ::recv returns the number of valid bytes in the buffer,\r
+  @return     This routine returns the number of valid bytes in the buffer,\r
               zero if no data was received, and -1 when an error occurs.\r
-              In the case of an error, errno contains more details.\r
+              In the case of an error, ::errno contains more details.\r
 \r
  **/\r
 ssize_t\r
@@ -45,7 +49,7 @@ recv (
   )\r
 {\r
   ssize_t BytesRead;\r
-  \r
+\r
   //\r
   //  Receive the data from the remote system\r
   //\r