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

v1.3.2

Browse Source
This commit is contained in:
h2zero
2022-01-15 15:23:57 -07:00
parent c51c0f2cf5
commit 6ae5666f7a
259 changed files with 4332 additions and 4672 deletions
Download Patch File Download Diff File Expand all files Collapse all files
class_nim_b_l_e_server.html
+56 -30
View File
@@ -3,9 +3,9 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.0"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp / NimBLE-Arduino: NimBLEServer Class Reference</title>
<title>esp-nimble-cpp: NimBLEServer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -25,8 +25,8 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">esp-nimble-cpp / NimBLE-Arduino
&#160;<span id="projectnumber">1.3.1</span>
<div id="projectname">esp-nimble-cpp
&#160;<span id="projectnumber">1.3.2</span>
</div>
</td>
</tr>
@@ -34,7 +34,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.0 -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
@@ -101,9 +101,9 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:aaeb58b4de85754d1aac6964e9248aa35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">createService</a> (const char *uuid)</td></tr>
<tr class="memdesc:aaeb58b4de85754d1aac6964e9248aa35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a BLE Service. <a href="class_nim_b_l_e_server.html#aaeb58b4de85754d1aac6964e9248aa35">More...</a><br /></td></tr>
<tr class="separator:aaeb58b4de85754d1aac6964e9248aa35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addc0753b57de87e172cc2d5f158bd6c6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#addc0753b57de87e172cc2d5f158bd6c6">createService</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint32_t numHandles=15, uint8_t inst_id=0)</td></tr>
<tr class="memdesc:addc0753b57de87e172cc2d5f158bd6c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a BLE Service. <a href="class_nim_b_l_e_server.html#addc0753b57de87e172cc2d5f158bd6c6">More...</a><br /></td></tr>
<tr class="separator:addc0753b57de87e172cc2d5f158bd6c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f0d43106db713e2ac716eabd70a10b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#a5f0d43106db713e2ac716eabd70a10b2">createService</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid)</td></tr>
<tr class="memdesc:a5f0d43106db713e2ac716eabd70a10b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a BLE Service. <a href="class_nim_b_l_e_server.html#a5f0d43106db713e2ac716eabd70a10b2">More...</a><br /></td></tr>
<tr class="separator:a5f0d43106db713e2ac716eabd70a10b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00c92f62f41ec1c499dfaf042b487d75"><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#a00c92f62f41ec1c499dfaf042b487d75">removeService</a> (<a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> *service, bool deleteSvc=false)</td></tr>
<tr class="memdesc:a00c92f62f41ec1c499dfaf042b487d75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a service from the server. <a href="class_nim_b_l_e_server.html#a00c92f62f41ec1c499dfaf042b487d75">More...</a><br /></td></tr>
<tr class="separator:a00c92f62f41ec1c499dfaf042b487d75"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -143,6 +143,9 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
<tr class="memitem:a9b08738766de90d7065263761314030a"><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#a9b08738766de90d7065263761314030a">updateConnParams</a> (uint16_t conn_handle, uint16_t minInterval, uint16_t maxInterval, uint16_t latency, uint16_t timeout)</td></tr>
<tr class="memdesc:a9b08738766de90d7065263761314030a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an Update the connection parameters: <a href="class_nim_b_l_e_server.html#a9b08738766de90d7065263761314030a">More...</a><br /></td></tr>
<tr class="separator:a9b08738766de90d7065263761314030a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15112931d1eb6226188c7e383523ba06"><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#a15112931d1eb6226188c7e383523ba06">setDataLen</a> (uint16_t conn_handle, uint16_t tx_octets)</td></tr>
<tr class="memdesc:a15112931d1eb6226188c7e383523ba06"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request an update of the data packet length. <a href="class_nim_b_l_e_server.html#a15112931d1eb6226188c7e383523ba06">More...</a><br /></td></tr>
<tr class="separator:a15112931d1eb6226188c7e383523ba06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9eb1f32b72ac93736585d6d89f393021"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_server.html#a9eb1f32b72ac93736585d6d89f393021">getPeerMTU</a> (uint16_t conn_id)</td></tr>
<tr class="memdesc:a9eb1f32b72ac93736585d6d89f393021"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the MTU of the client. <a href="class_nim_b_l_e_server.html#a9eb1f32b72ac93736585d6d89f393021">More...</a><br /></td></tr>
<tr class="separator:a9eb1f32b72ac93736585d6d89f393021"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -247,8 +250,8 @@ or created and later added to services list. </p>
</div>
</div>
<a id="addc0753b57de87e172cc2d5f158bd6c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addc0753b57de87e172cc2d5f158bd6c6">&#9670;&nbsp;</a></span>createService() <span class="overload">[2/2]</span></h2>
<a id="a5f0d43106db713e2ac716eabd70a10b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f0d43106db713e2ac716eabd70a10b2">&#9670;&nbsp;</a></span>createService() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -257,24 +260,8 @@ or created and later added to services list. </p>
<td class="memname"><a class="el" href="class_nim_b_l_e_service.html">NimBLEService</a> * NimBLEServer::createService </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;&#160;</td>
<td class="paramname"><em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td class="paramname"><em>uuid</em></td><td>)</td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>numHandles</em> = <code>15</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>inst_id</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
@@ -283,8 +270,6 @@ or created and later added to services list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>The UUID of the new service. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">numHandles</td><td>The maximum number of handles associated with this service. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">inst_id</td><td>if we have multiple services with the same UUID we need to provide inst_id value different for each service. </td></tr>
</table>
</dd>
</dl>
@@ -649,6 +634,47 @@ Advertising will need to be restarted by the user after calling this as we must
</dd>
</dl>
</div>
</div>
<a id="a15112931d1eb6226188c7e383523ba06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15112931d1eb6226188c7e383523ba06">&#9670;&nbsp;</a></span>setDataLen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLEServer::setDataLen </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>conn_handle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>tx_octets</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Request an update of the data packet length. </p>
<ul>
<li><p class="startli">Can only be used after a connection has been established.</p>
<p class="startli">Sends a data length update request to the peer. The Data Length Extension (DLE) allows to increase the Data Channel Payload from 27 bytes to up to 251 bytes. The peer needs to support the Bluetooth 4.2 specifications, to be capable of DLE. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">conn_handle</td><td>The connection handle of the peer to send the request to. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tx_octets</td><td>The preferred number of payload octets to use (Range 0x001B-0x00FB). </td></tr>
</table>
</dd>
</dl>
</li>
</ul>
</div>
</div>
<a id="a2540ae7b61fc6513f794da2512d66f74"></a>
@@ -738,7 +764,7 @@ Advertising will need to be restarted by the user after calling this as we must
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="class_nim_b_l_e_server.html">NimBLEServer</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.0 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>