diff options
| author | Simon Warta <[email protected]> | 2015-10-20 10:59:08 +0200 |
|---|---|---|
| committer | Simon Warta <[email protected]> | 2015-10-20 16:50:14 +0200 |
| commit | d82afc2461fd7c63cdd5beca06d241036c3153e4 (patch) | |
| tree | 1f487fe566c3c373d0aee1cfa087e3759efc271b /doc | |
| parent | 34d215b3341bd86b29819bb650d92a2a11f488eb (diff) | |
Update TLC::Client constructor documentation
[ci skip]
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/manual/tls.rst | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index ede415af6..0cccc03e9 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -194,19 +194,20 @@ TLS Clients .. cpp:class:: TLS::Client - .. cpp:function:: TLS::Client( \ - output_fn output, \ - data_cb data, \ - alert_cb alert, \ - handshake_cb handshake_complete, \ - TLS::Session_Manager& session_manager, \ - Credentials_Manager& credendials_manager, \ - const TLS::Policy& policy, \ - RandomNumberGenerator& rng, \ - const Server_Information& server_info, \ - const Protocol_Version offer_version, \ - const std::vector<std::string>& app_protocols, - size_t reserved_io_buffer_size) + .. cpp:function:: Client( \ + output_fn out, \ + data_cb app_data_cb, \ + alert_cb alert_cb, \ + handshake_cb hs_cb, \ + Session_Manager& session_manager, \ + Credentials_Manager& creds, \ + const Policy& policy, \ + RandomNumberGenerator& rng, \ + const Server_Information& server_info = Server_Information(), \ + const Protocol_Version offer_version = Protocol_Version::latest_tls_version(), \ + const std::vector<std::string>& next_protocols = {}, \ + size_t reserved_io_buffer_size = 16*1024 \ + ) Initialize a new TLS client. The constructor will immediately initiate a new session. |