summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJean-Paul Calderone <exarkun@twistedmatrix.com>2012-02-16 08:10:04 -0500
committerJean-Paul Calderone <exarkun@twistedmatrix.com>2012-02-16 08:10:04 -0500
commit6c896fea58ce9f9193f6085bab4fe7d5cf4b1360 (patch)
tree6cf91c6135fdbd986838096dd29eea2b9fe84f58
parent9c98bf96117ac820640737e15341c87fc48d34e9 (diff)
downloadpyopenssl-6c896fea58ce9f9193f6085bab4fe7d5cf4b1360.tar.gz
Add more API documentation for Session objects
-rw-r--r--doc/api/ssl.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
index 5014889..872cd5a 100644
--- a/doc/api/ssl.rst
+++ b/doc/api/ssl.rst
@@ -112,6 +112,15 @@ Context, Connection.
:py:const:`SSLv23_METHOD` or :py:const:`TLSv1_METHOD`.
+.. py:class:: Session()
+
+ A class representing an SSL session. A session defines certain connection
+ parameters which may be re-used to speed up the setup of subsequent
+ connections.
+
+ .. versionadded:: 0.14
+
+
.. py:data:: ConnectionType
See :py:class:`Connection`.
@@ -427,6 +436,14 @@ Context objects have the following methods:
.. versionadded:: 0.13
+.. _openssl-session:
+
+Session objects
+---------------
+
+Session objects have no methods.
+
+
.. _openssl-connection:
Connection objects
@@ -700,6 +717,22 @@ Connection objects have the following methods:
.. versionadded:: 0.13
+.. py:method:: Connection.get_session()
+
+ Get a :py:class:`Session` instance representing the SSL session in use by
+ the connection, or :py:obj:`None` if there is no session.
+
+ .. versionadded:: 0.14
+
+
+.. py:method:: Connection.set_session(session)
+
+ Set a new SSL session (using a :py:class:`Session` instance) to be used by
+ the connection.
+
+ .. versionadded:: 0.14
+
+
.. Rubric:: Footnotes
.. [#connection-context-socket] Actually, all that is required is an object that