Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

[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.
This commit is contained in:
Andrew M. Kuchling 2006-12-19 14:28:23 +00:00
parent 8fe2d2015d
commit 64df22bdb5
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Doc/lib/libsocket.tex
View File

@ -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