summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Paul Calderone <exarkun@twistedmatrix.com>2012-02-08 13:16:26 -0500
committerJean-Paul Calderone <exarkun@twistedmatrix.com>2012-02-08 13:16:26 -0500
commit8e8f90c85a87ad23b3d55bc35081aa340c863467 (patch)
tree472cfea31e58fd9fb15afed4103d8a1f47c086d4
parent5f67135478fd0c3f0c932206e316a434002dc4bd (diff)
downloadpyopenssl-8e8f90c85a87ad23b3d55bc35081aa340c863467.tar.gz
Add documentation for the new session cache related constants and methods
-rw-r--r--doc/api/ssl.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index 1eed876..5014889 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -69,6 +69,20 @@ Context, Connection.
information to retrieve. See the man page for the :py:func:`SSLeay_version` C
API for details.
+.. py:data:: SESS_CACHE_OFF
+ SESS_CACHE_CLIENT
+ SESS_CACHE_SERVER
+ SESS_CACHE_BOTH
+ SESS_CACHE_NO_AUTO_CLEAR
+ SESS_CACHE_NO_INTERNAL_LOOKUP
+ SESS_CACHE_NO_INTERNAL_STORE
+ SESS_CACHE_NO_INTERNAL
+
+ Constants used with :py:meth:`Context.set_session_cache_mode` to specify
+ the behavior of the session cache and potential session reuse. See the man
+ page for the :py:func:`SSL_CTX_set_session_cache_mode` C API for details.
+
+ .. versionadded:: 0.14
.. py:data:: OPENSSL_VERSION_NUMBER
@@ -315,6 +329,22 @@ Context objects have the following methods:
*callback* should return a false value (e.g. an empty string).
+.. py:method:: Context.set_session_cache_mode(mode)
+
+ Set the behavior of the session cache used by all connections using this
+ Context. The previously set mode is returned. See :py:const:`SESS_CACHE_*`
+ for details about particular modes.
+
+ .. versionadded:: 0.14
+
+
+.. py:method:: Context.get_session_cache_mode()
+
+ Get the current session cache mode.
+
+ .. versionadded:: 0.14
+
+
.. py:method:: Context.set_session_id(name)
Set the context *name* within which a session can be reused for this