aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-10-13 19:38:15 +0000
committerlloyd <[email protected]>2012-10-13 19:38:15 +0000
commited689a532a5938051dddebbda22d34b04f208164 (patch)
treee11653c6183fcb50d049a4389371d4c7edf7d217 /doc
parent5a6afba7f8d403cd29efe3302012ecf1b5f6ce5a (diff)
Remove TLS::Policy::pref_version. Instead pass the version to offer to
the Client constructor. Defaults to the most recent version of TLS. Allows TLS or DTLS, and means that it's possible to back down on the offered version, without requiring a Policy implementation with mutable state.
Diffstat (limited to 'doc')
-rw-r--r--doc/tls.rst19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/tls.rst b/doc/tls.rst
index 18af678b9..470405185 100644
--- a/doc/tls.rst
+++ b/doc/tls.rst
@@ -435,13 +435,6 @@ be negotiated during a handshake.
.. cpp:class:: TLS::Policy
- .. cpp:function:: Protocol_Version pref_version() const
-
- Return the protocol version we would prefer to negotiate. This is
- the version that clients will offer to servers.
-
- Default: TLS v1.2
-
.. cpp:function:: bool acceptable_protocol_version(Protocol_Version version)
Return true if this version of the protocol is one that we are
@@ -663,3 +656,15 @@ The ``TLS::Protocol_Version`` class represents a specific version:
Returns string description of the version, for instance "SSL v3",
"TLS v1.1", or "DTLS v1.0".
+
+ .. cpp:function:: static Protocol_Version latest_tls_version()
+
+ Returns the latest version of the TLS protocol known the the library
+ (currently TLS v1.2)
+
+ .. cpp:function:: static Protocol_Version latest_dtls_version()
+
+ Returns the latest version of the DTLS protocol known the the
+ library (currently DTLS v1.2)
+
+