From 724ae2b149b60063ff140f58d9d9a86f2fd93048 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Mon, 19 Sep 2011 14:28:06 +0200
Subject: [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
---
 lib/inets/doc/src/ftp.xml   | 21 ++++++++++++++++-----
 lib/inets/doc/src/notes.xml | 13 +++++++++----
 2 files changed, 25 insertions(+), 9 deletions(-)

(limited to 'lib/inets/doc/src')

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>
diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml
index c53aa653d8..061c8aa87c 100644
--- a/lib/inets/doc/src/notes.xml
+++ b/lib/inets/doc/src/notes.xml
@@ -35,17 +35,22 @@
   <section><title>Inets 5.8</title>
 
     <section><title>Improvements and New Features</title>
+<!--
     <p>-</p>
+-->
 
-<!--
       <list>
         <item>
-          <p>[httpc|httpd] Added support for IPv6 with ssl. </p>
-	  <p>Own Id: OTP-5566</p>
+          <p>[ftpc] Add a config option to specify a 
+	  <seealso marker="ftp#dtimeout">data connect timeout</seealso>.
+	  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. </p>
+	  <p>Own Id: OTP-9545</p>
         </item>
 
       </list>
--->
 
     </section>
 
-- 
cgit v1.2.3