diff Doc/lib/libsocket.tex @ 21213:3b09ea723ece legacy-trunk

Added documentation of the sendall() method, and a note to the send() method that it does not guarantee that all data is sent. This closes SF patch #474307.
author Fred Drake <fdrake@acm.org>
date Wed, 05 Dec 2001 05:25:59 +0000
parents 376ee174ecd0
children d089d1e8411c e0a5d16a9cb9
line wrap: on
line diff
--- a/Doc/lib/libsocket.tex	Wed Dec 05 00:30:09 2001 +0000
+++ b/Doc/lib/libsocket.tex	Wed Dec 05 05:25:59 2001 +0000
@@ -477,6 +477,19 @@
 Send data to the socket.  The socket must be connected to a remote
 socket.  The optional \var{flags} argument has the same meaning as for
 \method{recv()} above.  Returns the number of bytes sent.
+Applications are responsible for checking that all data has been sent;
+if only some of the data was transmitted, the application needs to
+attempt delivery of the remaining data.
+\end{methoddesc}
+
+\begin{methoddesc}[socket]{sendall}{string\optional{, flags}}
+Send data to the socket.  The socket must be connected to a remote
+socket.  The optional \var{flags} argument has the same meaning as for
+\method{recv()} above.  Unlike \method{send()}, this method continues
+to send data from \var{string} until either all data has been sent or
+an error occurs.  \code{None} is returned on success.  On error, an
+exception is raised, and there is no way to determine how much data,
+if any, was successfully sent.
 \end{methoddesc}
 
 \begin{methoddesc}[socket]{sendto}{string\optional{, flags}, address}