ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-12-25 04:00:46 +01:00
Code Issues Projects Releases Packages Wiki Activity
esp-nimble-cpp/_nim_b_l_e_descriptor_8h_source.html
h2zero 887379cd3f deploy: da48844e2f
2024-12-22 00:10:12 +00:00

192 lines
21 KiB
HTML
Raw Permalink 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/NimBLEDescriptor.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.2</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_descriptor_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">NimBLEDescriptor.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_DESCRIPTOR_H_</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_DESCRIPTOR_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_PERIPHERAL)</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;NimBLELocalValueAttribute.h&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor"># include &lt;string&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</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_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_descriptor.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a> : <span class="keyword">public</span> NimBLELocalValueAttribute {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_class" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* uuid, uint16_t properties, uint16_t maxLen, <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_class" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</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,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> uint16_t properties,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> uint16_t maxLen,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pCharacteristic = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="class_nim_b_l_e_descriptor.html">~NimBLEDescriptor</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> std::string <a class="code hl_function" href="class_nim_b_l_e_descriptor.html#a83b589a2022bbd86743b0ee4c3670a37">toString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a>(<a class="code hl_class" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>* pCallbacks);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* <a class="code hl_function" href="class_nim_b_l_e_descriptor.html#aa61b5f14156e9f378688ec875cf48309">getCharacteristic</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_service.html">NimBLEService</a>;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">void</span> setCharacteristic(<a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* pChar);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">void</span> readEvent(<a class="code hl_class" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>&amp; connInfo) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> writeEvent(<span class="keyword">const</span> uint8_t* val, uint16_t len, <a class="code hl_class" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>&amp; connInfo) <span class="keyword">override</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> <a class="code hl_class" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a>* m_pCallbacks{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_class" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a>* m_pCharacteristic{<span class="keyword">nullptr</span>};</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>}; <span class="comment">// NimBLEDescriptor</span></div>
</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="};">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_descriptor_callbacks.html"> 66</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> {</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_nim_b_l_e_descriptor_callbacks.html">~NimBLEDescriptorCallbacks</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_descriptor_callbacks.html#a061576b56702a6aca62a38f2ba27ba98">onRead</a>(<a class="code hl_class" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* pDescriptor, <a class="code hl_class" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>&amp; connInfo);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_nim_b_l_e_descriptor_callbacks.html#a2872d9e602d4e23cc63f55f5b2f76dd7">onWrite</a>(<a class="code hl_class" href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a>* pDescriptor, <a class="code hl_class" href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a>&amp; connInfo);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>};</div>
</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="preprocessor"># include &quot;NimBLE2904.h&quot;</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="preprocessor">#endif </span><span class="comment">/* CONFIG_BT_ENABLED &amp;&amp; CONFIG_BT_NIMBLE_ROLE_PERIPHERAL */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="preprocessor">#endif </span><span class="comment">/* NIMBLE_CPP_DESCRIPTOR_H_ */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aclass_nim_b_l_e_characteristic_html"><div class="ttname"><a href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a></div><div class="ttdoc">The model of a BLE Characteristic.</div><div class="ttdef"><b>Definition</b> NimBLECharacteristic.h:40</div></div>
<div class="ttc" id="aclass_nim_b_l_e_conn_info_html"><div class="ttname"><a href="class_nim_b_l_e_conn_info.html">NimBLEConnInfo</a></div><div class="ttdoc">Connection information.</div><div class="ttdef"><b>Definition</b> NimBLEConnInfo.h:32</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_callbacks_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a></div><div class="ttdoc">Callbacks that can be associated with a BLE descriptors to inform of events.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.h:66</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_callbacks_html_a061576b56702a6aca62a38f2ba27ba98"><div class="ttname"><a href="class_nim_b_l_e_descriptor_callbacks.html#a061576b56702a6aca62a38f2ba27ba98">NimBLEDescriptorCallbacks::onRead</a></div><div class="ttdeci">virtual void onRead(NimBLEDescriptor *pDescriptor, NimBLEConnInfo &amp;connInfo)</div><div class="ttdoc">Callback function to support a read request.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.cpp:138</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_callbacks_html_a2872d9e602d4e23cc63f55f5b2f76dd7"><div class="ttname"><a href="class_nim_b_l_e_descriptor_callbacks.html#a2872d9e602d4e23cc63f55f5b2f76dd7">NimBLEDescriptorCallbacks::onWrite</a></div><div class="ttdeci">virtual void onWrite(NimBLEDescriptor *pDescriptor, NimBLEConnInfo &amp;connInfo)</div><div class="ttdoc">Callback function to support a write request.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.cpp:147</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</a></div><div class="ttdoc">A model of a BLE descriptor.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.h:33</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_a83b589a2022bbd86743b0ee4c3670a37"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#a83b589a2022bbd86743b0ee4c3670a37">NimBLEDescriptor::toString</a></div><div class="ttdeci">std::string toString() const</div><div class="ttdoc">Return a string representation of the descriptor.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.cpp:117</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_aa61b5f14156e9f378688ec875cf48309"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#aa61b5f14156e9f378688ec875cf48309">NimBLEDescriptor::getCharacteristic</a></div><div class="ttdeci">NimBLECharacteristic * getCharacteristic() const</div><div class="ttdoc">Get the characteristic this descriptor belongs to.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.cpp:89</div></div>
<div class="ttc" id="aclass_nim_b_l_e_descriptor_html_aa9cb8727f9e17cf8050cf619e5fe3096"><div class="ttname"><a href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">NimBLEDescriptor::setCallbacks</a></div><div class="ttdeci">void setCallbacks(NimBLEDescriptorCallbacks *pCallbacks)</div><div class="ttdoc">Set the callback handlers for this descriptor.</div><div class="ttdef"><b>Definition</b> NimBLEDescriptor.cpp:97</div></div>
<div class="ttc" id="aclass_nim_b_l_e_service_html"><div class="ttname"><a href="class_nim_b_l_e_service.html">NimBLEService</a></div><div class="ttdoc">The model of a BLE service.</div><div class="ttdef"><b>Definition</b> NimBLEService.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>NimBLEDescriptor.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