Browse code

tls: doc - removed handshake_timeout and send_timeout

Andrei Pelinescu-Onciul authored on 27/05/2010 18:00:00
Showing 2 changed files
... ...
@@ -397,36 +397,32 @@ modparam("tls", "cipher_list", "HIGH")
397 397
 
398 398
 1.8.9. send_timeout (int)
399 399
 
400
-   Sets the maximum interval of time after which SIP-router will give up
401
-   trying to send a message over TLS (time after a TLS send will be
402
-   aborted and the corresponding TLS connection closed). The value is in
403
-   seconds.
404
-
405
-   The default value is 120 s.
400
+   This parameter is obsolete and cannot be used in newer TLS versions (>
401
+   sip-router 3.0). In these versions the send_timeout is replaced by
402
+   tcp_send_timeout (common with all the tcp connections).
406 403
 
407 404
    Example 10. Set send_timeout parameter
408 405
 ...
409
-modparam("tls", "send_timeout", 1)
406
+tls_send_timeout = 10
410 407
 ...
411 408
 
412 409
 1.8.10. handshake_timeout (int)
413 410
 
414
-   Sets the maximum interval of time after which SIP-router will give up
415
-   trying to accept a TLS connection or connect to a TLS peer. The value
416
-   is in seconds.
417
-
418
-   The default value is 120 s.
411
+   This parameter is obsolete and cannot be used in newer TLS versions (>
412
+   sip-router 3.0). In these versions the handshake_timeout is replaced by
413
+   tcp_connect_timeout (common with all the tcp connections).
419 414
 
420 415
    Example 11. Set handshake_timeout parameter
421 416
 ...
422
-modparam("tls", "handshake_timeout", 1)
417
+tcp_connect_timeout = 60
423 418
 ...
424 419
 
425 420
 1.8.11. connection_timeout (int)
426 421
 
427 422
    Sets the amount of time after which an idle TLS connection will be
428
-   closed. This is similar to tcp_connection_lifetime. The value is
429
-   expressed in seconds.
423
+   closed, if no I/O ever occured after the initial open. If an I/O event
424
+   occurs, the timeout will be extended with tcp_connection_lifetime. The
425
+   value is expressed in seconds.
430 426
 
431 427
    The default value is 10 min.
432 428
 
... ...
@@ -201,16 +201,15 @@ modparam("tls", "cipher_list", "HIGH")
201 201
 	<section id="send_timeout">
202 202
 	<title><varname>send_timeout</varname> (int)</title>
203 203
 	<para>
204
-		Sets the maximum interval of time after which SIP-router will give up trying to send a message over TLS (time after a TLS send will be aborted and the corresponding TLS connection closed). The value is in seconds.
205
-	</para>
206
-	<para>
207
-		The default value is 120 s.
204
+		This parameter is obsolete and cannot be used in newer TLS versions
205
+		(&gt; sip-router 3.0). In these versions the send_timeout is
206
+		replaced by tcp_send_timeout (common with all the tcp connections).
208 207
 	</para>
209 208
 	<example>
210 209
 	    <title>Set <varname>send_timeout</varname> parameter</title>
211 210
 	    <programlisting>
212 211
 ...
213
-modparam("tls", "send_timeout", 1)
212
+tls_send_timeout = 10
214 213
 ...
215 214
 	    </programlisting>
216 215
 	</example>
... ...
@@ -219,16 +218,15 @@ modparam("tls", "send_timeout", 1)
219 218
 	<section id="handshake_timeout">
220 219
 	<title><varname>handshake_timeout</varname> (int)</title>
221 220
 	<para>
222
-		Sets the maximum interval of time after which SIP-router will give up trying to accept a TLS connection or connect to a TLS peer. The value is in seconds.
223
-	</para>
224
-	<para>
225
-		The default value is 120 s.
221
+		This parameter is obsolete and cannot be used in newer TLS versions
222
+		(&gt; sip-router 3.0). In these versions the handshake_timeout is
223
+		replaced by tcp_connect_timeout (common with all the tcp connections).
226 224
 	</para>
227 225
 	<example>
228 226
 	    <title>Set <varname>handshake_timeout</varname> parameter</title>
229 227
 	    <programlisting>
230 228
 ...
231
-modparam("tls", "handshake_timeout", 1)
229
+tcp_connect_timeout = 60
232 230
 ...
233 231
 	    </programlisting>
234 232
 	</example>
... ...
@@ -237,7 +235,10 @@ modparam("tls", "handshake_timeout", 1)
237 235
 	<section id="connection_timeout">
238 236
 	<title><varname>connection_timeout</varname> (int)</title>
239 237
 	<para>
240
-		Sets the amount of time after which an idle TLS connection will be closed. This is similar to tcp_connection_lifetime. The value is expressed in seconds.
238
+		Sets the amount of time after which an idle TLS connection will be
239
+		closed, if no I/O ever occured after the initial open. If an I/O event
240
+		occurs, the timeout will be extended with tcp_connection_lifetime.
241
+		The value is expressed in seconds.
241 242
 	</para>
242 243
 	<para>
243 244
 		The default value is 10 min.