From 52261db09ef9dbf5abc95baed22722c5c332f9f7 Mon Sep 17 00:00:00 2001
From: Rob Austein <sra@hactrn.net>
Date: Tue, 20 Jun 2006 17:33:26 +0000
Subject: Pulling OpenSSL 0.9.8b into trunk

svn path=/openssl/trunk; revision=3
---
 openssl/trunk/doc/ssl/SSL_get_default_timeout.pod | 41 +++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 openssl/trunk/doc/ssl/SSL_get_default_timeout.pod

(limited to 'openssl/trunk/doc/ssl/SSL_get_default_timeout.pod')

diff --git a/openssl/trunk/doc/ssl/SSL_get_default_timeout.pod b/openssl/trunk/doc/ssl/SSL_get_default_timeout.pod
new file mode 100644
index 00000000..a648a9b8
--- /dev/null
+++ b/openssl/trunk/doc/ssl/SSL_get_default_timeout.pod
@@ -0,0 +1,41 @@
+=pod
+
+=head1 NAME
+
+SSL_get_default_timeout - get default session timeout value
+
+=head1 SYNOPSIS
+
+ #include <openssl/ssl.h>
+
+ long SSL_get_default_timeout(const SSL *ssl);
+
+=head1 DESCRIPTION
+
+SSL_get_default_timeout() returns the default timeout value assigned to
+SSL_SESSION objects negotiated for the protocol valid for B<ssl>.
+
+=head1 NOTES
+
+Whenever a new session is negotiated, it is assigned a timeout value,
+after which it will not be accepted for session reuse. If the timeout
+value was not explicitly set using
+L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>, the hardcoded default
+timeout for the protocol will be used.
+
+SSL_get_default_timeout() return this hardcoded value, which is 300 seconds
+for all currently supported protocols (SSLv2, SSLv3, and TLSv1).
+
+=head1 RETURN VALUES
+
+See description.
+
+=head1 SEE ALSO
+
+L<ssl(3)|ssl(3)>,
+L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,
+L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,
+L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>,
+L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>
+
+=cut
-- 
cgit v1.2.3