diff options
| author | lloyd <[email protected]> | 2012-10-13 19:47:33 +0000 |
|---|---|---|
| committer | lloyd <[email protected]> | 2012-10-13 19:47:33 +0000 |
| commit | 9f1f35d7afc019ae03d478dc30f9552f6ba31a22 (patch) | |
| tree | 5fa57cc77ebb928ed8efa7cde70bb2881b2c4d97 /doc | |
| parent | ed689a532a5938051dddebbda22d34b04f208164 (diff) | |
Fix TLS doc formatting. Note removal of pref_version
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/relnotes/1_11_1.rst | 4 | ||||
| -rw-r--r-- | doc/tls.rst | 14 |
2 files changed, 11 insertions, 7 deletions
diff --git a/doc/relnotes/1_11_1.rst b/doc/relnotes/1_11_1.rst index 0619e07ac..bfc513d04 100644 --- a/doc/relnotes/1_11_1.rst +++ b/doc/relnotes/1_11_1.rst @@ -8,6 +8,10 @@ Initial support for DTLS (both v1.0 and v1.2) is available in this release, though it should be considered highly experimental. Currently timeouts and retransmissions are not handled. +The :cpp:class:`TLS::Client` constructor now takes the version to +offer to the server. The policy hook :cpp:class:`TLS::Policy` function +`pref_version`, which previously controlled this, has been removed. + :cpp:class:`TLS::Session_Manager_In_Memory` now chooses a random 256-bit key at startup and encrypts all sessions (using the existing :cpp:func:`TLS::Session::encrypt` mechanism) while they are stored in diff --git a/doc/tls.rst b/doc/tls.rst index 470405185..a0f2c4f48 100644 --- a/doc/tls.rst +++ b/doc/tls.rst @@ -166,7 +166,7 @@ TLS Clients const TLS::Policy& policy, \ RandomNumberGenerator& rng, \ const Server_Information& server_info = Server_Information(), \ - std::function<std::string, std::vector<std::string> > next_protocol) + std::function<std::string, std::vector<std::string>> next_protocol) Initialize a new TLS client. The constructor will immediately initiate a new session. @@ -657,14 +657,14 @@ 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() + .. cpp:function:: static Protocol_Version latest_tls_version() - Returns the latest version of the TLS protocol known the the library - (currently TLS v1.2) + Returns the latest version of the TLS protocol known the the library + (currently TLS v1.2) - .. cpp:function:: static Protocol_Version latest_dtls_version() + .. cpp:function:: static Protocol_Version latest_dtls_version() - Returns the latest version of the DTLS protocol known the the - library (currently DTLS v1.2) + Returns the latest version of the DTLS protocol known the the + library (currently DTLS v1.2) |