[Python-checkins] CVS: python/dist/src/Doc/lib libsocket.tex,1.57,1.58

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv15374/lib

Modified Files:
	libsocket.tex 
Log Message:
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.


Index: libsocket.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libsocket.tex,v
retrieving revision 1.57
retrieving revision 1.58
diff -C2 -d -r1.57 -r1.58
*** libsocket.tex	2001/10/20 04:24:09	1.57
--- libsocket.tex	2001/12/05 05:25:59	1.58
***************
*** 478,481 ****
--- 478,494 ----
  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}