This commit is contained in:
h2zero committed 2022-01-15 15:23:57 -07:00
1 parent c51c0f2cf5
commit 6ae5666f7a
259 files changed
+4332 -4672

No files matched your search

+51 -7
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: NimBLECharacteristic Class Reference</title>
<title>esp-nimble-cpp: NimBLECharacteristic 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');
@@ -132,6 +132,11 @@ An indication will block waiting for a positive confirmation from the client. <b
A notification is a transmission of up to the first 20 bytes of the characteristic value.<br />
A notification will not block; it is a fire and forget. <a href="class_nim_b_l_e_characteristic.html#aa45461059e1992c816e32c371d17e813">More...</a><br /></td></tr>
<tr class="separator:aa45461059e1992c816e32c371d17e813"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad44ce481c0341abe32b1e0f823c520d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#ad44ce481c0341abe32b1e0f823c520d4">notify</a> (std::string value, bool is_notification=true)</td></tr>
<tr class="memdesc:ad44ce481c0341abe32b1e0f823c520d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a notification.<br />
A notification is a transmission of up to the first 20 bytes of the characteristic value.<br />
A notification will not block; it is a fire and forget. <a href="class_nim_b_l_e_characteristic.html#ad44ce481c0341abe32b1e0f823c520d4">More...</a><br /></td></tr>
<tr class="separator:ad44ce481c0341abe32b1e0f823c520d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aced225d46153b6969f6ded30c0190e39"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">getSubscribedCount</a> ()</td></tr>
<tr class="memdesc:aced225d46153b6969f6ded30c0190e39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of clients subscribed to the characteristic. <a href="class_nim_b_l_e_characteristic.html#aced225d46153b6969f6ded30c0190e39">More...</a><br /></td></tr>
<tr class="separator:aced225d46153b6969f6ded30c0190e39"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -652,7 +657,7 @@ template&lt;typename T &gt; </div>
</div>
</div>
<a id="aa45461059e1992c816e32c371d17e813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa45461059e1992c816e32c371d17e813">&#9670;&nbsp;</a></span>notify()</h2>
<h2 class="memtitle"><span class="permalink"><a href="#aa45461059e1992c816e32c371d17e813">&#9670;&nbsp;</a></span>notify() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -677,6 +682,45 @@ A notification will not block; it is a fire and forget. </p>
</dd>
</dl>
</div>
</div>
<a id="ad44ce481c0341abe32b1e0f823c520d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad44ce481c0341abe32b1e0f823c520d4">&#9670;&nbsp;</a></span>notify() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void NimBLECharacteristic::notify </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>is_notification</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a notification.<br />
A notification is a transmission of up to the first 20 bytes of the characteristic value.<br />
A notification will not block; it is a fire and forget. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>An optional value to send as the notification, else the current characteristic value is used. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">is_notification</td><td>if true sends a notification, false sends an indication. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2c0ed8932ee257a8632e3d72e353489b"></a>
@@ -869,7 +913,7 @@ template&lt;typename T &gt; </div>
<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_characteristic.html">NimBLECharacteristic</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>