regenerated documentation
This commit is contained in:
Noah Laptop
parent
5c643d015e
commit
431df02b5b
23 changed files with 416 additions and 147 deletions
|
|
@ -96,7 +96,7 @@ $(document).ready(function(){initNavTree('class_s_s_l_client_impl.html','');});
|
|||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Implementation code to be inherited by <a class="el" href="class_s_s_l_client.html" title="The main SSLClient class Check out README.md for more info.">SSLClient</a>.
|
||||
<p>Implementation code to be inherited by <a class="el" href="class_s_s_l_client.html" title="The main SSLClient class. Check out README.md for more info.">SSLClient</a>.
|
||||
<a href="class_s_s_l_client_impl.html#details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="_s_s_l_client_impl_8h_source.html">SSLClientImpl.h</a>></code></p>
|
||||
|
|
@ -106,7 +106,7 @@ Inheritance diagram for SSLClientImpl:</div>
|
|||
<div class="center">
|
||||
<img src="class_s_s_l_client_impl.png" usemap="#SSLClientImpl_map" alt=""/>
|
||||
<map id="SSLClientImpl_map" name="SSLClientImpl_map">
|
||||
<area href="class_s_s_l_client.html" title="The main SSLClient class Check out README.md for more info." alt="SSLClient< C, SessionCache >" shape="rect" coords="0,112,190,136"/>
|
||||
<area href="class_s_s_l_client.html" title="The main SSLClient class. Check out README.md for more info." alt="SSLClient< C, SessionCache >" shape="rect" coords="0,112,190,136"/>
|
||||
</map>
|
||||
</div></div>
|
||||
<table class="memberdecls">
|
||||
|
|
@ -180,7 +180,7 @@ Protected Member Functions</h2></td></tr>
|
|||
<tr class="separator:ada595ed8f11673a9180ef0b762949c83"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Implementation code to be inherited by <a class="el" href="class_s_s_l_client.html" title="The main SSLClient class Check out README.md for more info.">SSLClient</a>. </p>
|
||||
<div class="textblock"><p>Implementation code to be inherited by <a class="el" href="class_s_s_l_client.html" title="The main SSLClient class. Check out README.md for more info.">SSLClient</a>. </p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a id="a2b0b9043c8252871272bf6ba199ab67b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a2b0b9043c8252871272bf6ba199ab67b">◆ </a></span>SSLClientImpl()</h2>
|
||||
|
|
@ -227,7 +227,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#ae9a7509bc8a18f67e286547c19deb3c0" title="Initialize SSLClient with all of the prerequisites needed.">SSLClient::SSLClient</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ae9a7509bc8a18f67e286547c19deb3c0" title="Initialize SSLClient with all of the prerequisites needed.">SSLClient::SSLClient</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -246,7 +246,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a40ec85568d0aec376219125b604dbc29" title="Returns the number of bytes availible to read from the SSL Socket.">SSLClient::available</a> </dd></dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a40ec85568d0aec376219125b604dbc29" title="Returns the number of bytes available to read from the data that has been received and decrypted.">SSLClient::available</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -322,7 +322,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a7318aadc0ec9775bffaaac0b1f00aaf8" title="Check if the device is connected. Use this function to determine if SSLClient is still connected and ...">SSLClient::connected</a> </dd></dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a7318aadc0ec9775bffaaac0b1f00aaf8" title="Check if the device is connected.">SSLClient::connected</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -340,7 +340,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a51eb668f6a328a6a66298c6bc1361d41" title="Force writing the buffered bytes from SSLClient::write to the network. This function is blocking unti...">SSLClient::flush</a> </dd></dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a51eb668f6a328a6a66298c6bc1361d41" title="Force writing the buffered bytes from SSLClient::write to the network.">SSLClient::flush</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -366,7 +366,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#ab3ebfbca41a56bfa11e34aac2c2e0106" title="return an instance of m_client that is polymorphic and can be used by SSLClientImpl">SSLClient::get_arduino_client</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ab3ebfbca41a56bfa11e34aac2c2e0106" title="Returns an instance of m_client that is polymorphic and can be used by SSLClientImpl.">SSLClient::get_arduino_client</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="class_s_s_l_client.html#ab3ebfbca41a56bfa11e34aac2c2e0106">SSLClient< C, SessionCache ></a>.</p>
|
||||
|
||||
|
|
@ -421,7 +421,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#aaa52b481eb1d36a0ae1d208daa2fec51" title="return an instance of the session array that is on the stack">SSLClient::get_session_array</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#aaa52b481eb1d36a0ae1d208daa2fec51" title="Returns an instance of the session array that is on the stack.">SSLClient::get_session_array</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="class_s_s_l_client.html#aaa52b481eb1d36a0ae1d208daa2fec51">SSLClient< C, SessionCache ></a>.</p>
|
||||
|
||||
|
|
@ -479,7 +479,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#ae3f27a36ff9c0cd1e2bea5e1708b6e4f" title="Get a session reference corresponding to a host and IP, or a reference to a empty session if none exi...">SSLClient::getSession</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ae3f27a36ff9c0cd1e2bea5e1708b6e4f" title="Gets a session reference corresponding to a host and IP, or a reference to a empty session if none ex...">SSLClient::getSession</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -505,7 +505,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#a36bb344866e4cbcba3bbfcf4d33e5187" title="Get the maximum number of SSL sessions that can be stored at once.">SSLClient::getSessionCount</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a36bb344866e4cbcba3bbfcf4d33e5187" title="Get the maximum number of SSL sessions that can be stored at once.">SSLClient::getSessionCount</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="class_s_s_l_client.html#a36bb344866e4cbcba3bbfcf4d33e5187">SSLClient< C, SessionCache ></a>.</p>
|
||||
|
||||
|
|
@ -533,7 +533,7 @@ Protected Member Functions</h2></td></tr>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#ac725067566ee411680c88575c148300b" title="Returns the local port, C::localPort exists. Else return 0.">SSLClient::localPort</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ac725067566ee411680c88575c148300b" title="Returns the local port, C::localPort exists. Else return 0.">SSLClient::localPort</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="class_s_s_l_client.html#ac725067566ee411680c88575c148300b">SSLClient< C, SessionCache ></a>.</p>
|
||||
|
||||
|
|
@ -829,7 +829,7 @@ template<typename T > </div>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a227b1cbbe91bcb21153c09f97d0dd484" title="view the first byte of the buffer, without removing it from the SSLClient Buffer The implementation f...">SSLClient::peek</a> </dd></dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a227b1cbbe91bcb21153c09f97d0dd484" title="View the first byte of the buffer, without removing it from the SSLClient Buffer.">SSLClient::peek</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -858,7 +858,7 @@ template<typename T > </div>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ae31dd88a1af8ec3794fb48f26a3dd4bf" title="Read size bytes from the SSL socket buffer, copying them into *buf, and return the number of bytes re...">SSLClient::read(uint8_t*, size_t)</a> </dd></dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ae31dd88a1af8ec3794fb48f26a3dd4bf" title="Read size bytes from the SSL client buffer, copying them into *buf, and return the number of bytes re...">SSLClient::read(uint8_t*, size_t)</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -884,7 +884,7 @@ template<typename T > </div>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#ae2d1d17ee568ec2a37756bf6894dcd05" title="Returns the remote IP, if C::remoteIP exists. Else return INADDR_NONE.">SSLClient::remoteIP</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ae2d1d17ee568ec2a37756bf6894dcd05" title="Returns the remote IP, if C::remoteIP exists. Else return INADDR_NONE.">SSLClient::remoteIP</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="class_s_s_l_client.html#ae2d1d17ee568ec2a37756bf6894dcd05">SSLClient< C, SessionCache ></a>.</p>
|
||||
|
||||
|
|
@ -912,7 +912,7 @@ template<typename T > </div>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#ac725067566ee411680c88575c148300b" title="Returns the local port, C::localPort exists. Else return 0.">SSLClient::localPort</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#ac725067566ee411680c88575c148300b" title="Returns the local port, C::localPort exists. Else return 0.">SSLClient::localPort</a> </dd></dl>
|
||||
|
||||
<p>Implemented in <a class="el" href="class_s_s_l_client.html#ae8bd9420fec3b11f855729c4ecfe1c2c">SSLClient< C, SessionCache ></a>.</p>
|
||||
|
||||
|
|
@ -943,7 +943,7 @@ template<typename T > </div>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>See <a class="el" href="class_s_s_l_client.html#a0000d7f1e8656cf4a506a98133391fe0" title="Clear the session corresponding to a host and IP.">SSLClient::removeSession</a> </p>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a0000d7f1e8656cf4a506a98133391fe0" title="Clear the session corresponding to a host and IP.">SSLClient::removeSession</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -961,7 +961,7 @@ template<typename T > </div>
|
|||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a158d87df3fe118b7565a19b72f310322" title="Close the connection If the SSL session is still active, all incoming data is discarded and BearSSL w...">SSLClient::stop</a> </dd></dl>
|
||||
<dl class="section see"><dt>See also</dt><dd><a class="el" href="class_s_s_l_client.html#a158d87df3fe118b7565a19b72f310322" title="Close the connection.">SSLClient::stop</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue