diff options
| author | Micael Karlberg <[email protected]> | 2011-09-19 14:28:06 +0200 |
|---|---|---|
| committer | Micael Karlberg <[email protected]> | 2011-09-19 14:28:06 +0200 |
| commit | 724ae2b149b60063ff140f58d9d9a86f2fd93048 (patch) | |
| tree | 58188efd5694f0f4aeec258eea69612581e09f9e /lib/inets/doc/src/ftp.xml | |
| parent | 4b8958c0397765bd208dbf0dd297c654ed0c33d1 (diff) | |
| download | otp-724ae2b149b60063ff140f58d9d9a86f2fd93048.tar.gz otp-724ae2b149b60063ff140f58d9d9a86f2fd93048.tar.bz2 otp-724ae2b149b60063ff140f58d9d9a86f2fd93048.zip | |
[ftpc] Add a config option to specify a data connect timeout.
That is how long the ftp client will wait for the server to connect
to the data socket. If this timeout occurs, an error will be returned
to the caller and the ftp client process will be terminated.
OTP-9545
Diffstat (limited to 'lib/inets/doc/src/ftp.xml')
| -rw-r--r-- | lib/inets/doc/src/ftp.xml | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/lib/inets/doc/src/ftp.xml b/lib/inets/doc/src/ftp.xml index ca902d8d9d..f8f11ec705 100644 --- a/lib/inets/doc/src/ftp.xml +++ b/lib/inets/doc/src/ftp.xml @@ -1,10 +1,10 @@ -<?xml version="1.0" encoding="latin1" ?> +<?xml version="1.0" encoding="iso-8859-1" ?> <!DOCTYPE erlref SYSTEM "erlref.dtd"> <erlref> <header> <copyright> - <year>1997</year><year>2010</year> + <year>1997</year><year>2011</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -141,11 +141,21 @@ <tag>{timeout, Timeout}</tag> <item> <marker id="timeout"></marker> - <p>Timeout = <c>integer() >= 0</c> </p> + <p>Timeout = <c>non_neg_integer()</c> </p> <p>Connection timeout. </p> <p>Default is 60000 (milliseconds). </p> </item> + <tag>{dtimeout, DTimeout}</tag> + <item> + <marker id="dtimeout"></marker> + <p>DTimeout = <c>non_neg_integer() | infinity</c> </p> + <p>Data Connect timeout. + The time the client will wait for the server to connect to the + data socket. </p> + <p>Default is infinity. </p> + </item> + <tag>{progress, Progress}</tag> <item> <marker id="progress"></marker> @@ -542,11 +552,12 @@ <v>verbose() = boolean() (defaults to false)</v> <v>debug() = disable | debug | trace (defaults to disable)</v> <!-- <v>open_options() = [open_option()]</v> --> - <v>open_option() = {ipfamily, ipfamily()} | {port, port()} | {mode, mode()} | {timeout, timeout()} | {progress, progress()}</v> + <v>open_option() = {ipfamily, ipfamily()} | {port, port()} | {mode, mode()} | {timeout, timeout()} | {dtimeout, dtimeout()} | {progress, progress()}</v> <v>ipfamily() = inet | inet6 | inet6fb4 (defaults to inet)</v> <v>port() = integer() > 0 (defaults to 21)</v> <v>mode() = active | passive (defaults to passive)</v> - <v>timeout() = integer() >= 0 (defaults to 60000 milliseconds)</v> + <v>timeout() = integer() > 0 (defaults to 60000 milliseconds)</v> + <v>dtimeout() = integer() > 0 | infinity (defaults to infinity)</v> <v>pogress() = ignore | {module(), function(), initial_data()} (defaults to ignore)</v> <v>module() = atom()</v> <v>function() = atom()</v> |