diff options
author | Guido van Rossum <guido@python.org> | 1997-12-03 19:34:14 (GMT) |
---|---|---|
committer | Guido van Rossum <guido@python.org> | 1997-12-03 19:34:14 (GMT) |
commit | ab76af3d65812005f254166433efde43554431ad (patch) | |
tree | 93aaa7f2dcc52c4ba07033b3ed08b8fb4b69bac8 /Doc/lib/libftplib.tex | |
parent | 98ee50b5a458b9aaa20ae6a19baea9ecc0d453fa (diff) | |
download | cpython-ab76af3d65812005f254166433efde43554431ad.zip cpython-ab76af3d65812005f254166433efde43554431ad.tar.gz cpython-ab76af3d65812005f254166433efde43554431ad.tar.bz2 |
Provide default for blocksize on retrbinary (Skip Montanaro).
Diffstat (limited to 'Doc/lib/libftplib.tex')
-rw-r--r-- | Doc/lib/libftplib.tex | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/lib/libftplib.tex b/Doc/lib/libftplib.tex index dfbaa2b..a89c6a9 100644 --- a/Doc/lib/libftplib.tex +++ b/Doc/lib/libftplib.tex @@ -125,14 +125,15 @@ Return nothing if a response code in the range 200--299 is received. Raise an exception otherwise. \end{funcdesc} -\begin{funcdesc}{retrbinary}{command\, callback\, maxblocksize} +\begin{funcdesc}{retrbinary}{command\, callback\optional{\, maxblocksize}} Retrieve a file in binary transfer mode. \var{command} should be an appropriate \samp{RETR} command, i.e.\ \code{"RETR \var{filename}"}. The \var{callback} function is called for each block of data received, with a single string argument giving the data block. -The \var{maxblocksize} argument specifies the maximum block size -(which may not be the actual size of the data blocks passed to -\var{callback}). +The optional \var{maxblocksize} argument specifies the maximum chunk size to +read on the low-level socket object created to do the actual transfer +(which will also be the largest size of the data blocks passed to +\var{callback}). A reasonable default is chosen. \end{funcdesc} \begin{funcdesc}{retrlines}{command\optional{\, callback}} |