feedc0de/esp-nimble-cpp
1
0 Fork 0
forked from h2zero/esp-nimble-cpp
Code Pull Requests Activity

Release v1.4.0

Browse Source
This commit is contained in:
h2zero committed 2022-07-31 11:38:16 -06:00
1 parent 6ae5666f7a
commit a116f0d0c0
238 files changed
+9929 -4077
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

class_nim_b_l_e_server.html
+94 -17
View File
@@ -26,7 +26,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.3.2</span>
&#160;<span id="projectnumber">1.4.0</span>
</div>
</td>
</tr>
@@ -111,19 +111,21 @@ Public Member Functions</h2></td></tr>
<tr class="memdesc:a6eda4c9e0ac1dd031c678d4bf7da1d56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a service which was either already created but removed from availability,<br />
or created and later added to services list. <a href="class_nim_b_l_e_server.html#a6eda4c9e0ac1dd031c678d4bf7da1d56">More...</a><br /></td></tr>
<tr class="separator:a6eda4c9e0ac1dd031c678d4bf7da1d56"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab41d8bb9b334734f95a726f1e15200fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_advertising.html">NimBLEAdvertising</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">getAdvertising</a> ()</td></tr>
<tr class="memdesc:ab41d8bb9b334734f95a726f1e15200fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the advertising object that can be used to advertise the existence of the server. <a href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">More...</a><br /></td></tr>
<tr class="separator:ab41d8bb9b334734f95a726f1e15200fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a485c90ce36275f9e4ec26a7f3d348cd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#a485c90ce36275f9e4ec26a7f3d348cd9">setCallbacks</a> (<a class="el" href="class_nim_b_l_e_server_callbacks.html">NimBLEServerCallbacks</a> *pCallbacks, bool deleteCallbacks=true)</td></tr>
<tr class="memdesc:a485c90ce36275f9e4ec26a7f3d348cd9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the server callbacks. <a href="class_nim_b_l_e_server.html#a485c90ce36275f9e4ec26a7f3d348cd9">More...</a><br /></td></tr>
<tr class="separator:a485c90ce36275f9e4ec26a7f3d348cd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2540ae7b61fc6513f794da2512d66f74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#a2540ae7b61fc6513f794da2512d66f74">startAdvertising</a> ()</td></tr>
<tr class="memdesc:a2540ae7b61fc6513f794da2512d66f74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start advertising. <a href="class_nim_b_l_e_server.html#a2540ae7b61fc6513f794da2512d66f74">More...</a><br /></td></tr>
<tr class="separator:a2540ae7b61fc6513f794da2512d66f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab713fd5619ddbfc1a88bf43a1686f454"><td class="memItemLeft" align="right" valign="top"><a id="ab713fd5619ddbfc1a88bf43a1686f454"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#ab713fd5619ddbfc1a88bf43a1686f454">stopAdvertising</a> ()</td></tr>
<tr class="memdesc:ab713fd5619ddbfc1a88bf43a1686f454"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop advertising. <br /></td></tr>
<tr class="separator:ab713fd5619ddbfc1a88bf43a1686f454"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab41d8bb9b334734f95a726f1e15200fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_ext_advertising.html">NimBLEExtAdvertising</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">getAdvertising</a> ()</td></tr>
<tr class="memdesc:ab41d8bb9b334734f95a726f1e15200fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the advertising object that can be used to advertise the existence of the server. <a href="class_nim_b_l_e_server.html#ab41d8bb9b334734f95a726f1e15200fc">More...</a><br /></td></tr>
<tr class="separator:ab41d8bb9b334734f95a726f1e15200fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f4b6c2fc5602f5ec34f963df6a21f75"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#a8f4b6c2fc5602f5ec34f963df6a21f75">startAdvertising</a> (uint8_t inst_id, int duration=0, int max_events=0)</td></tr>
<tr class="memdesc:a8f4b6c2fc5602f5ec34f963df6a21f75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start advertising. <a href="class_nim_b_l_e_server.html#a8f4b6c2fc5602f5ec34f963df6a21f75">More...</a><br /></td></tr>
<tr class="separator:a8f4b6c2fc5602f5ec34f963df6a21f75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af827ef8988c1584795447a634502f0df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#af827ef8988c1584795447a634502f0df">stopAdvertising</a> (uint8_t inst_id)</td></tr>
<tr class="memdesc:af827ef8988c1584795447a634502f0df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function to stop advertising a data set. <a href="class_nim_b_l_e_server.html#af827ef8988c1584795447a634502f0df">More...</a><br /></td></tr>
<tr class="separator:af827ef8988c1584795447a634502f0df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a4c114b572675e82700604db29e6e25"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#a7a4c114b572675e82700604db29e6e25">stopAdvertising</a> ()</td></tr>
<tr class="memdesc:a7a4c114b572675e82700604db29e6e25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop advertising. <a href="class_nim_b_l_e_server.html#a7a4c114b572675e82700604db29e6e25">More...</a><br /></td></tr>
<tr class="separator:a7a4c114b572675e82700604db29e6e25"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae94ad52f3c97f62553af9765acdb7bcb"><td class="memItemLeft" align="right" valign="top"><a id="ae94ad52f3c97f62553af9765acdb7bcb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#ae94ad52f3c97f62553af9765acdb7bcb">start</a> ()</td></tr>
<tr class="memdesc:ae94ad52f3c97f62553af9765acdb7bcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the GATT server. Required to be called after setup of all services and characteristics / descriptors for the NimBLE host to register them. <br /></td></tr>
@@ -584,7 +586,7 @@ or created and later added to services list. </p>
</div><div class="memdoc">
<p>Remove a service from the server. </p>
<p>Immediately removes access to the service by clients, sends a service changed indication, and removes the service (if applicable) from the advertisments. The service is not deleted unless the deleteSvc parameter is true, otherwise the service remains available and can be re-added in the future. If desired a removed but not deleted service can be deleted later by calling this method with deleteSvc set to true.</p>
<p>Immediately removes access to the service by clients, sends a service changed indication, and removes the service (if applicable) from the advertisements. The service is not deleted unless the deleteSvc parameter is true, otherwise the service remains available and can be re-added in the future. If desired a removed but not deleted service can be deleted later by calling this method with deleteSvc set to true.</p>
<dl class="section note"><dt>Note</dt><dd>The service will not be removed from the database until all open connections are closed as it requires resetting the GATT server. In the interim the service will have it's visibility disabled.</dd>
<dd>
Advertising will need to be restarted by the user after calling this as we must stop advertising in order to remove the service.</dd></dl>
@@ -677,14 +679,62 @@ Advertising will need to be restarted by the user after calling this as we must
</div>
</div>
<a id="a2540ae7b61fc6513f794da2512d66f74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2540ae7b61fc6513f794da2512d66f74">&#9670;&nbsp;</a></span>startAdvertising()</h2>
<a id="a8f4b6c2fc5602f5ec34f963df6a21f75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f4b6c2fc5602f5ec34f963df6a21f75">&#9670;&nbsp;</a></span>startAdvertising()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEServer::startAdvertising </td>
<td class="memname">bool NimBLEServer::startAdvertising </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>duration</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_events</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start advertising. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to start. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">duration</td><td>How long to advertise for in milliseconds, 0 = forever (default). </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">max_events</td><td>Maximum number of advertisement events to send, 0 = no limit (default). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising started successfully.</dd></dl>
<p>Start the server advertising its existence. This is a convenience function and is equivalent to retrieving the advertising object and invoking start upon it.</p>
<dl class="section return"><dt>Returns</dt><dd>True if advertising started successfully.</dd></dl>
<p>Start the server advertising its existence. This is a convenience function and is equivalent to retrieving the advertising object and invoking start upon it. </p>
</div>
</div>
<a id="a7a4c114b572675e82700604db29e6e25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a4c114b572675e82700604db29e6e25">&#9670;&nbsp;</a></span>stopAdvertising() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEServer::stopAdvertising </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
@@ -692,8 +742,35 @@ Advertising will need to be restarted by the user after calling this as we must
</table>
</div><div class="memdoc">
<p>Start advertising. </p>
<p>Start the server advertising its existence. This is a convenience function and is equivalent to retrieving the advertising object and invoking start upon it. </p>
<p>Stop advertising. </p>
<dl class="section return"><dt>Returns</dt><dd>True if advertising stopped successfully. </dd></dl>
</div>
</div>
<a id="af827ef8988c1584795447a634502f0df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af827ef8988c1584795447a634502f0df">&#9670;&nbsp;</a></span>stopAdvertising() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool NimBLEServer::stopAdvertising </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convenience function to stop advertising a data set. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>The extended advertisement instance ID to stop advertising. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if advertising stopped successfully. </dd></dl>
</div>
</div>