summaryrefslogtreecommitdiffstats
path: root/Doc/library/ssl.rst
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2010-10-12 20:09:02 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2010-10-12 20:09:02 (GMT)
commitb0182c8ca5a98d2c61f44e87e9b5dc6e8b7a9f30 (patch)
tree4677fbfdcdfb7c90184fb4cfdc66cf5221156521 /Doc/library/ssl.rst
parent0518842b692a0f698018e35a0f754118b4762fbd (diff)
downloadcpython-b0182c8ca5a98d2c61f44e87e9b5dc6e8b7a9f30.zip
cpython-b0182c8ca5a98d2c61f44e87e9b5dc6e8b7a9f30.tar.gz
cpython-b0182c8ca5a98d2c61f44e87e9b5dc6e8b7a9f30.tar.bz2
Issue #10075: Add a session_stats() method to SSLContext objects.
Diffstat (limited to 'Doc/library/ssl.rst')
-rw-r--r--Doc/library/ssl.rst26
1 files changed, 21 insertions, 5 deletions
diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index f36dbc7..c9c6ca0 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -481,13 +481,17 @@ SSL Contexts
.. versionadded:: 3.2
+An SSL context holds various data longer-lived than single SSL connections,
+such as SSL configuration options, certificate(s) and private key(s).
+It also manages a cache of SSL sessions for server-side sockets, in order
+to speed up repeated connections from the same clients.
+
.. class:: SSLContext(protocol)
- An object holding various data longer-lived than single SSL connections,
- such as SSL configuration options, certificate(s) and private key(s).
- You must pass *protocol* which must be one of the ``PROTOCOL_*`` constants
- defined in this module. :data:`PROTOCOL_SSLv23` is recommended for
- maximum interoperability.
+ Create a new SSL context. You must pass *protocol* which must be one
+ of the ``PROTOCOL_*`` constants defined in this module.
+ :data:`PROTOCOL_SSLv23` is recommended for maximum interoperability.
+
:class:`SSLContext` objects have the following methods and attributes:
@@ -542,6 +546,18 @@ SSL Contexts
and *suppress_ragged_eofs* have the same meaning as in the top-level
:func:`wrap_socket` function.
+.. method:: SSLContext.session_stats()
+
+ Get statistics about the SSL sessions created or managed by this context.
+ A dictionary is returned which maps the names of each `piece of information
+ <http://www.openssl.org/docs/ssl/SSL_CTX_sess_number.html>`_ to their
+ numeric values. For example, here is the total number of hits and misses
+ in the session cache since the context was created::
+
+ >>> stats = context.session_stats()
+ >>> stats['hits'], stats['misses']
+ (0, 0)
+
.. attribute:: SSLContext.options
An integer representing the set of SSL options enabled on this context.