summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew M. Kuchling <amk@amk.ca>2006-12-19 14:28:23 (GMT)
committerAndrew M. Kuchling <amk@amk.ca>2006-12-19 14:28:23 (GMT)
commit64df22bdb5872bf63bd580ea6191a309a7a7c0a2 (patch)
tree052ac5a69a81acdef9bcf3fc594ac41443f253c0
parent8fe2d2015dc57e4e048f733c7fbb5c0712b05d15 (diff)
downloadcpython-64df22bdb5872bf63bd580ea6191a309a7a7c0a2.zip
cpython-64df22bdb5872bf63bd580ea6191a309a7a7c0a2.tar.gz
cpython-64df22bdb5872bf63bd580ea6191a309a7a7c0a2.tar.bz2
[Bug #1613651] Document socket.recv_into, socket.recvfrom_into
Also, the text for recvfrom told you to read recv() for an explanation of the 'flags' argument, but recv() just pointed you at the man page. Copied the man-page text to recvfrom(), recvfrom_into, recv_into to avoid the pointless redirection. I don't have LaTeX on this machine; hope my markup is OK.
-rw-r--r--Doc/lib/libsocket.tex25
1 files changed, 23 insertions, 2 deletions
diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex
index f510fd4..f20c56c 100644
--- a/Doc/lib/libsocket.tex
+++ b/Doc/lib/libsocket.tex
@@ -569,11 +569,32 @@ at once is specified by \var{bufsize}. See the \UNIX{} manual page
Receive data from the socket. The return value is a pair
\code{(\var{string}, \var{address})} where \var{string} is a string
representing the data received and \var{address} is the address of the
-socket sending the data. The optional \var{flags} argument has the
-same meaning as for \method{recv()} above.
+socket sending the data. See the \UNIX{} manual page
+\manpage{recv}{2} for the meaning of the optional argument
+\var{flags}; it defaults to zero.
(The format of \var{address} depends on the address family --- see above.)
\end{methoddesc}
+\begin{methoddesc}[socket]{recvfrom_into}{buffer\optional{, nbytes\optional{, flags}}}
+Receive data from the socket, writing it into \var{buffer} instead of
+creating a new string. The return value is a pair
+\code{(\var{nbytes}, \var{address})} where \var{nbytes} is the number
+of bytes received and \var{address} is the address of the socket
+sending the data. See the \UNIX{} manual page
+\manpage{recv}{2} for the meaning of the optional argument
+\var{flags}; it defaults to zero. (The format of \var{address}
+depends on the address family --- see above.)
+\end{methoddesc}
+
+\begin{methoddesc}[socket]{recv_into}{buffer\optional{, nbytes\optional{, flags}}}
+Receive up to \var{nbytes} bytes from the socket,
+storing the data into a buffer rather than creating a new string.
+If \var{nbytes} is not specified (or 0),
+receive up to the size available in the given buffer.
+See the \UNIX{} manual page \manpage{recv}{2} for the meaning of the
+optional argument \var{flags}; it defaults to zero.
+\end{methoddesc}
+
\begin{methoddesc}[socket]{send}{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