lmoskala/SSLClient
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

final update to documentation before version release

Browse source
This commit is contained in:
Noah Laptop 2019-08-14 11:19:56 -07:00
parent 26e054bd76
commit c157c00f69
3 changed files with 22 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/html/_s_s_l_client_8h_source.html
View file

File diff suppressed because one or more lines are too long

3
docs/html/class_s_s_l_client.html
View file

@ -1203,7 +1203,8 @@ template&lt;class C , size_t SessionCache = 1&gt; </div>
</div><div class="memdoc"> </div><div class="memdoc">
<p>Add a client certificate and enable support for mutual auth. </p> <p>Add a client certificate and enable support for mutual auth. </p>
<p>This function must be called BEFORE making an SSL connection. </p> <p>Please ensure that the values in <code>params</code> are valid for the lifetime of <a class="el" href="class_s_s_l_client.html" title="The main SSLClient class. Check out README.md for more info.">SSLClient</a>. You may want to make them global constants.</p>
<dl class="section pre"><dt>Precondition</dt><dd><a class="el" href="class_s_s_l_client.html" title="The main SSLClient class. Check out README.md for more info.">SSLClient</a> has not already started an SSL connection. </dd></dl>
</div> </div>
</div> </div>

5
src/SSLClient.h
View file

@ -292,7 +292,10 @@ public:
/** /**
* @brief Add a client certificate and enable support for mutual auth * @brief Add a client certificate and enable support for mutual auth
* *
* This function must be called BEFORE making an SSL connection. * Please ensure that the values in `params` are valid for the lifetime
* of SSLClient. You may want to make them global constants.
*
* @pre SSLClient has not already started an SSL connection.
*/ */
void setMutualAuthParams(const SSLClientParameters* params) { return set_mutual_impl(params); } void setMutualAuthParams(const SSLClientParameters* params) { return set_mutual_impl(params); }