ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-26 04:30:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_remote_characteristic_8h_source.html
h2zero 059364985d deploy: 275def333c
2024-12-17 01:50:27 +00:00

214 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>esp-nimble-cpp: /github/workspace/src/NimBLERemoteCharacteristic.h Source File</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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">esp-nimble-cpp<span id="projectnumber">&#160;2.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_nim_b_l_e_remote_characteristic_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">NimBLERemoteCharacteristic.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Copyright 2020-2024 Ryan Powell &lt;ryan@nable-embedded.io&gt; and</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * esp-nimble-cpp, NimBLE-Arduino contributors.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * limitations under the License.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include &quot;<a class="code" href="nimconfig_8h.html">nimconfig.h</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if defined(CONFIG_BT_ENABLED) &amp;&amp; defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor"># include &quot;NimBLERemoteValueAttribute.h&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor"># include &lt;vector&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor"># include &lt;functional&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="};">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_remote_characteristic.html"> 34</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a> : <span class="keyword">public</span> NimBLERemoteValueAttribute {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> std::string <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#ad77a00c64a83dd58e985e3bbefd87ce2">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a1b3bbd1bcdde6dd952ee69ebad0ffc58">getRemoteService</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a1b021f9ca0501abed573daee878b51eb">deleteDescriptors</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a03c4da5f5fc36bd5f66c39aed3feb6f2">deleteDescriptor</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a0d8e8ae12a89d64d0ca52dd3b3b7c67d">canBroadcast</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a4be19e1a3a82f3db0fa8a7236638b737">canRead</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a0920d576b12ee1e20a724a7da836d153">canWriteNoResponse</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a3ba2263c976bd4ece81a6b37e09fa121">canWrite</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#ae3b10383d5b72bdf241bb2f215836772">canNotify</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a79dbe281933d8cab342a5506746b9ded">canIndicate</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#afb07f80d83e41768d228b92210b83657">canWriteSigned</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#aff5a242abcba3f239bd177cebc69e1cb">hasExtendedProps</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="class_nim_b_l_e_client.html">NimBLEClient</a>* getClient() <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">typedef</span> std::function&lt;void(<a class="code hl_class" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>* pBLERemoteCharacteristic, uint8_t* pData, <span class="keywordtype">size_t</span> length, <span class="keywordtype">bool</span> isNotify)&gt; notify_callback;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#adf445e6bd9dee047a61c708ae943304a">subscribe</a>(<span class="keywordtype">bool</span> notifications = <span class="keyword">true</span>, <span class="keyword">const</span> notify_callback notifyCallback = <span class="keyword">nullptr</span>, <span class="keywordtype">bool</span> response = <span class="keyword">true</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a64a74ffc6612cf4a42f33836e34887f0">unsubscribe</a>(<span class="keywordtype">bool</span> response = <span class="keyword">true</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> std::vector&lt;NimBLERemoteDescriptor*&gt;::iterator <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a160cf1b93ae583038606d27b258156e9">begin</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> std::vector&lt;NimBLERemoteDescriptor*&gt;::iterator <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a17aea026b6a795dbb6bcdc27bbe3d17e">end</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_class" href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a>* <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a8a2e29de02b97c99e88ce1a56e54cdd7">getDescriptor</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>&amp; uuid) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> std::vector&lt;NimBLERemoteDescriptor*&gt;&amp; <a class="code hl_function" href="class_nim_b_l_e_remote_characteristic.html#a27746c8b2405beb1d44567e2c1f85f87">getDescriptors</a>(<span class="keywordtype">bool</span> refresh = <span class="keyword">false</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_client.html">NimBLEClient</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>;</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <a class="code hl_class" href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* pRemoteService, <span class="keyword">const</span> ble_gatt_chr* chr);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <a class="code hl_class" href="class_nim_b_l_e_remote_characteristic.html">~NimBLERemoteCharacteristic</a>();</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">bool</span> setNotify(uint16_t val, notify_callback notifyCallback = <span class="keyword">nullptr</span>, <span class="keywordtype">bool</span> response = <span class="keyword">true</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keywordtype">bool</span> retrieveDescriptors(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>* uuidFilter = <span class="keyword">nullptr</span>) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">static</span> <span class="keywordtype">int</span> descriptorDiscCB(</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> uint16_t conn_handle, <span class="keyword">const</span> ble_gatt_error* error, uint16_t chr_val_handle, <span class="keyword">const</span> ble_gatt_dsc* dsc, <span class="keywordtype">void</span>* arg);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a>* m_pRemoteService{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> uint8_t m_properties{0};</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">mutable</span> notify_callback m_notifyCallback{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">mutable</span> std::vector&lt;NimBLERemoteDescriptor*&gt; m_vDescriptors{};</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>}; <span class="comment">// NimBLERemoteCharacteristic</span></div>
</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED &amp;&amp; CONFIG_BT_NIMBLE_ROLE_CENTRAL */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="preprocessor">#endif </span><span class="comment">/* NIMBLE_CPP_REMOTE_CHARACTERISTIC_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_client_html"><div class="ttname"><a href="class_nim_b_l_e_client.html">NimBLEClient</a></div><div class="ttdoc">A model of a BLE client.</div><div class="ttdef"><b>Definition</b> NimBLEClient.h:49</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html">NimBLERemoteCharacteristic</a></div><div class="ttdoc">A model of a remote BLE characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.h:34</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a03c4da5f5fc36bd5f66c39aed3feb6f2"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a03c4da5f5fc36bd5f66c39aed3feb6f2">NimBLERemoteCharacteristic::deleteDescriptor</a></div><div class="ttdeci">size_t deleteDescriptor(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Delete descriptor by UUID.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:293</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0920d576b12ee1e20a724a7da836d153"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0920d576b12ee1e20a724a7da836d153">NimBLERemoteCharacteristic::canWriteNoResponse</a></div><div class="ttdeci">bool canWriteNoResponse() const</div><div class="ttdoc">Does the characteristic support writing without a response?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:328</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a0d8e8ae12a89d64d0ca52dd3b3b7c67d"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a0d8e8ae12a89d64d0ca52dd3b3b7c67d">NimBLERemoteCharacteristic::canBroadcast</a></div><div class="ttdeci">bool canBroadcast() const</div><div class="ttdoc">Does the characteristic support value broadcasting?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:312</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a160cf1b93ae583038606d27b258156e9"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a160cf1b93ae583038606d27b258156e9">NimBLERemoteCharacteristic::begin</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator begin() const</div><div class="ttdoc">Get iterator to the beginning of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:208</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a17aea026b6a795dbb6bcdc27bbe3d17e"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a17aea026b6a795dbb6bcdc27bbe3d17e">NimBLERemoteCharacteristic::end</a></div><div class="ttdeci">std::vector&lt; NimBLERemoteDescriptor * &gt;::iterator end() const</div><div class="ttdoc">Get iterator to the end of the vector of remote descriptor pointers.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:216</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a1b021f9ca0501abed573daee878b51eb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a1b021f9ca0501abed573daee878b51eb">NimBLERemoteCharacteristic::deleteDescriptors</a></div><div class="ttdeci">void deleteDescriptors() const</div><div class="ttdoc">Delete the descriptors in the descriptor vector.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:277</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a1b3bbd1bcdde6dd952ee69ebad0ffc58"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a1b3bbd1bcdde6dd952ee69ebad0ffc58">NimBLERemoteCharacteristic::getRemoteService</a></div><div class="ttdeci">const NimBLERemoteService * getRemoteService() const</div><div class="ttdoc">Get the remote service associated with this characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:224</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a27746c8b2405beb1d44567e2c1f85f87"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a27746c8b2405beb1d44567e2c1f85f87">NimBLERemoteCharacteristic::getDescriptors</a></div><div class="ttdeci">const std::vector&lt; NimBLERemoteDescriptor * &gt; &amp; getDescriptors(bool refresh=false) const</div><div class="ttdoc">Get a pointer to the vector of found descriptors.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:195</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a3ba2263c976bd4ece81a6b37e09fa121"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a3ba2263c976bd4ece81a6b37e09fa121">NimBLERemoteCharacteristic::canWrite</a></div><div class="ttdeci">bool canWrite() const</div><div class="ttdoc">Does the characteristic support writing?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:336</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a4be19e1a3a82f3db0fa8a7236638b737"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a4be19e1a3a82f3db0fa8a7236638b737">NimBLERemoteCharacteristic::canRead</a></div><div class="ttdeci">bool canRead() const</div><div class="ttdoc">Does the characteristic support reading?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:320</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a64a74ffc6612cf4a42f33836e34887f0"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a64a74ffc6612cf4a42f33836e34887f0">NimBLERemoteCharacteristic::unsubscribe</a></div><div class="ttdeci">bool unsubscribe(bool response=true) const</div><div class="ttdoc">Unsubscribe for notifications or indications.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:267</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a79dbe281933d8cab342a5506746b9ded"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a79dbe281933d8cab342a5506746b9ded">NimBLERemoteCharacteristic::canIndicate</a></div><div class="ttdeci">bool canIndicate() const</div><div class="ttdoc">Does the characteristic support indication?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:352</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_a8a2e29de02b97c99e88ce1a56e54cdd7"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#a8a2e29de02b97c99e88ce1a56e54cdd7">NimBLERemoteCharacteristic::getDescriptor</a></div><div class="ttdeci">NimBLERemoteDescriptor * getDescriptor(const NimBLEUUID &amp;uuid) const</div><div class="ttdoc">Get the descriptor instance with the given UUID that belongs to this characteristic.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:138</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ad77a00c64a83dd58e985e3bbefd87ce2"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ad77a00c64a83dd58e985e3bbefd87ce2">NimBLERemoteCharacteristic::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Convert a NimBLERemoteCharacteristic to a string representation;.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:376</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_adf445e6bd9dee047a61c708ae943304a"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#adf445e6bd9dee047a61c708ae943304a">NimBLERemoteCharacteristic::subscribe</a></div><div class="ttdeci">bool subscribe(bool notifications=true, const notify_callback notifyCallback=nullptr, bool response=true) const</div><div class="ttdoc">Subscribe for notifications or indications.</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:258</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_ae3b10383d5b72bdf241bb2f215836772"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#ae3b10383d5b72bdf241bb2f215836772">NimBLERemoteCharacteristic::canNotify</a></div><div class="ttdeci">bool canNotify() const</div><div class="ttdoc">Does the characteristic support reading with encryption?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:344</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_afb07f80d83e41768d228b92210b83657"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#afb07f80d83e41768d228b92210b83657">NimBLERemoteCharacteristic::canWriteSigned</a></div><div class="ttdeci">bool canWriteSigned() const</div><div class="ttdoc">Does the characteristic support signed writing?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:360</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_characteristic_html_aff5a242abcba3f239bd177cebc69e1cb"><div class="ttname"><a href="class_nim_b_l_e_remote_characteristic.html#aff5a242abcba3f239bd177cebc69e1cb">NimBLERemoteCharacteristic::hasExtendedProps</a></div><div class="ttdeci">bool hasExtendedProps() const</div><div class="ttdoc">Does the characteristic support extended properties?</div><div class="ttdef"><b>Definition</b> NimBLERemoteCharacteristic.cpp:368</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_remote_descriptor.html">NimBLERemoteDescriptor</a></div><div class="ttdoc">A model of remote BLE descriptor.</div><div class="ttdef"><b>Definition</b> NimBLERemoteDescriptor.h:32</div></div>
<div class="ttc" id="aclass_nim_b_l_e_remote_service_html"><div class="ttname"><a href="class_nim_b_l_e_remote_service.html">NimBLERemoteService</a></div><div class="ttdoc">A model of a remote BLE service.</div><div class="ttdef"><b>Definition</b> NimBLERemoteService.h:34</div></div>
<div class="ttc" id="aclass_nim_b_l_e_u_u_i_d_html"><div class="ttname"><a href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a></div><div class="ttdoc">A model of a BLE UUID.</div><div class="ttdef"><b>Definition</b> NimBLEUUID.h:41</div></div>
<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLERemoteCharacteristic.h</b></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.8 </li>
</ul>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink