|
| 1 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> |
| 3 | +<head> |
| 4 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| 6 | +<meta name="generator" content="Doxygen 1.9.8"/> |
| 7 | +<meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | +<title>esp-nimble-cpp: /github/workspace/src/NimBLEAttribute.h Source File</title> |
| 9 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | +<script type="text/javascript" src="jquery.js"></script> |
| 11 | +<script type="text/javascript" src="dynsections.js"></script> |
| 12 | +<link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | +<script type="text/javascript" src="resize.js"></script> |
| 14 | +<script type="text/javascript" src="navtreedata.js"></script> |
| 15 | +<script type="text/javascript" src="navtree.js"></script> |
| 16 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 17 | +<script type="text/javascript" src="search/searchdata.js"></script> |
| 18 | +<script type="text/javascript" src="search/search.js"></script> |
| 19 | +<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 20 | +</head> |
| 21 | +<body> |
| 22 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 23 | +<div id="titlearea"> |
| 24 | +<table cellspacing="0" cellpadding="0"> |
| 25 | + <tbody> |
| 26 | + <tr id="projectrow"> |
| 27 | + <td id="projectalign"> |
| 28 | + <div id="projectname">esp-nimble-cpp<span id="projectnumber"> 2.0.0</span> |
| 29 | + </div> |
| 30 | + </td> |
| 31 | + </tr> |
| 32 | + </tbody> |
| 33 | +</table> |
| 34 | +</div> |
| 35 | +<!-- end header part --> |
| 36 | +<!-- Generated by Doxygen 1.9.8 --> |
| 37 | +<script type="text/javascript"> |
| 38 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 39 | +var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| 40 | +/* @license-end */ |
| 41 | +</script> |
| 42 | +<script type="text/javascript" src="menudata.js"></script> |
| 43 | +<script type="text/javascript" src="menu.js"></script> |
| 44 | +<script type="text/javascript"> |
| 45 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 46 | +$(function() { |
| 47 | + initMenu('',true,false,'search.php','Search'); |
| 48 | + $(document).ready(function() { init_search(); }); |
| 49 | +}); |
| 50 | +/* @license-end */ |
| 51 | +</script> |
| 52 | +<div id="main-nav"></div> |
| 53 | +<script type="text/javascript"> |
| 54 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 55 | +$(document).ready(function() { init_codefold(0); }); |
| 56 | +/* @license-end */ |
| 57 | +</script> |
| 58 | +</div><!-- top --> |
| 59 | +<div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 60 | + <div id="nav-tree"> |
| 61 | + <div id="nav-tree-contents"> |
| 62 | + <div id="nav-sync" class="sync"></div> |
| 63 | + </div> |
| 64 | + </div> |
| 65 | + <div id="splitbar" style="-moz-user-select:none;" |
| 66 | + class="ui-resizable-handle"> |
| 67 | + </div> |
| 68 | +</div> |
| 69 | +<script type="text/javascript"> |
| 70 | +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| 71 | +$(document).ready(function(){initNavTree('_nim_b_l_e_attribute_8h_source.html',''); initResizable(); }); |
| 72 | +/* @license-end */ |
| 73 | +</script> |
| 74 | +<div id="doc-content"> |
| 75 | +<!-- window showing the filter options --> |
| 76 | +<div id="MSearchSelectWindow" |
| 77 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 78 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 79 | + onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 80 | +</div> |
| 81 | + |
| 82 | +<!-- iframe showing the search results (closed by default) --> |
| 83 | +<div id="MSearchResultsWindow"> |
| 84 | +<div id="MSearchResults"> |
| 85 | +<div class="SRPage"> |
| 86 | +<div id="SRIndex"> |
| 87 | +<div id="SRResults"></div> |
| 88 | +<div class="SRStatus" id="Loading">Loading...</div> |
| 89 | +<div class="SRStatus" id="Searching">Searching...</div> |
| 90 | +<div class="SRStatus" id="NoMatches">No Matches</div> |
| 91 | +</div> |
| 92 | +</div> |
| 93 | +</div> |
| 94 | +</div> |
| 95 | + |
| 96 | +<div class="header"> |
| 97 | + <div class="headertitle"><div class="title">NimBLEAttribute.h</div></div> |
| 98 | +</div><!--header--> |
| 99 | +<div class="contents"> |
| 100 | +<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| 101 | +<div class=" line" ><a id=" l00002" name=" l00002" ></a><span class=" lineno" > 2 </span><span class=" comment" > * Copyright 2020-2024 Ryan Powell < [email protected]> and </span></div> |
| 102 | +<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> |
| 103 | +<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div> |
| 104 | +<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 "License");</span></div> |
| 105 | +<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> |
| 106 | +<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> |
| 107 | +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div> |
| 108 | +<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> |
| 109 | +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> *</span></div> |
| 110 | +<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> |
| 111 | +<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 "AS IS" BASIS,</span></div> |
| 112 | +<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> |
| 113 | +<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> |
| 114 | +<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * limitations under the License.</span></div> |
| 115 | +<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> */</span></div> |
| 116 | +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div> |
| 117 | +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef NIMBLE_CPP_ATTRIBUTE_H_</span></div> |
| 118 | +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define NIMBLE_CPP_ATTRIBUTE_H_</span></div> |
| 119 | +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> |
| 120 | +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include "<a class="code" href="nimconfig_8h.html">nimconfig.h</a>"</span></div> |
| 121 | +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#if defined(CONFIG_BT_ENABLED) && (defined(CONFIG_BT_NIMBLE_ROLE_PERIPHERAL) || defined(CONFIG_BT_NIMBLE_ROLE_CENTRAL))</span></div> |
| 122 | +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> |
| 123 | +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor"># include "NimBLEUUID.h"</span></div> |
| 124 | +<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div> |
| 125 | +<div class="foldopen" id="foldopen00029" data-start="{" data-end="};"> |
| 126 | +<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_attribute.html"> 29</a></span><span class="keyword">class </span><a class="code hl_class" href="class_nim_b_l_e_attribute.html">NimBLEAttribute</a> {</div> |
| 127 | +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div> |
| 128 | +<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_attribute.html#afd4500e543c9480c52ca994ed5473e49"> 35</a></span> <span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>& <a class="code hl_function" href="class_nim_b_l_e_attribute.html#afd4500e543c9480c52ca994ed5473e49">getUUID</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_uuid; }</div> |
| 129 | +<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div> |
| 130 | +<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_attribute.html#a7907cb5b0a2d0f8cd9eb016a4ed876d1"> 40</a></span> uint16_t <a class="code hl_function" href="class_nim_b_l_e_attribute.html#a7907cb5b0a2d0f8cd9eb016a4ed876d1">getHandle</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_handle; };</div> |
| 131 | +<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> |
| 132 | +<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">protected</span>:</div> |
| 133 | +<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_attribute.html#a51ce8e9cd9609f42b9b9248a0b6c642c"> 48</a></span> <a class="code hl_function" href="class_nim_b_l_e_attribute.html#a51ce8e9cd9609f42b9b9248a0b6c642c">NimBLEAttribute</a>(<span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a>& uuid, uint16_t handle) : m_uuid{uuid}, m_handle{handle} {}</div> |
| 134 | +<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> |
| 135 | +<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="class_nim_b_l_e_attribute.html#a8a060f480742cfb09ed47c1f5421d00f"> 53</a></span> <a class="code hl_function" href="class_nim_b_l_e_attribute.html#a8a060f480742cfb09ed47c1f5421d00f">~NimBLEAttribute</a>() = <span class="keywordflow">default</span>;</div> |
| 136 | +<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div> |
| 137 | +<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">const</span> <a class="code hl_class" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> m_uuid{};</div> |
| 138 | +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> uint16_t m_handle{0};</div> |
| 139 | +<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>};</div> |
| 140 | +</div> |
| 141 | +<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div> |
| 142 | +<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="preprocessor">#endif </span><span class="comment">// CONFIG_BT_ENABLED && (CONFIG_BT_NIMBLE_ROLE_PERIPHERAL || CONFIG_BT_NIMBLE_ROLE_CENTRAL)</span></div> |
| 143 | +<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="preprocessor">#endif </span><span class="comment">// NIMBLE_CPP_ATTRIBUTE_H_</span></div> |
| 144 | +<div class="ttc" id="aclass_nim_b_l_e_attribute_html"><div class="ttname"><a href="class_nim_b_l_e_attribute.html">NimBLEAttribute</a></div><div class="ttdoc">A base class for BLE attributes.</div><div class="ttdef"><b>Definition</b> NimBLEAttribute.h:29</div></div> |
| 145 | +<div class="ttc" id="aclass_nim_b_l_e_attribute_html_a51ce8e9cd9609f42b9b9248a0b6c642c"><div class="ttname"><a href="class_nim_b_l_e_attribute.html#a51ce8e9cd9609f42b9b9248a0b6c642c">NimBLEAttribute::NimBLEAttribute</a></div><div class="ttdeci">NimBLEAttribute(const NimBLEUUID &uuid, uint16_t handle)</div><div class="ttdoc">Construct a new NimBLEAttribute object.</div><div class="ttdef"><b>Definition</b> NimBLEAttribute.h:48</div></div> |
| 146 | +<div class="ttc" id="aclass_nim_b_l_e_attribute_html_a7907cb5b0a2d0f8cd9eb016a4ed876d1"><div class="ttname"><a href="class_nim_b_l_e_attribute.html#a7907cb5b0a2d0f8cd9eb016a4ed876d1">NimBLEAttribute::getHandle</a></div><div class="ttdeci">uint16_t getHandle() const</div><div class="ttdoc">Get the handle of the attribute.</div><div class="ttdef"><b>Definition</b> NimBLEAttribute.h:40</div></div> |
| 147 | +<div class="ttc" id="aclass_nim_b_l_e_attribute_html_a8a060f480742cfb09ed47c1f5421d00f"><div class="ttname"><a href="class_nim_b_l_e_attribute.html#a8a060f480742cfb09ed47c1f5421d00f">NimBLEAttribute::~NimBLEAttribute</a></div><div class="ttdeci">~NimBLEAttribute()=default</div><div class="ttdoc">Destroy the NimBLEAttribute object.</div></div> |
| 148 | +<div class="ttc" id="aclass_nim_b_l_e_attribute_html_afd4500e543c9480c52ca994ed5473e49"><div class="ttname"><a href="class_nim_b_l_e_attribute.html#afd4500e543c9480c52ca994ed5473e49">NimBLEAttribute::getUUID</a></div><div class="ttdeci">const NimBLEUUID & getUUID() const</div><div class="ttdoc">Get the UUID of the attribute.</div><div class="ttdef"><b>Definition</b> NimBLEAttribute.h:35</div></div> |
| 149 | +<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> |
| 150 | +<div class="ttc" id="animconfig_8h_html"><div class="ttname"><a href="nimconfig_8h.html">nimconfig.h</a></div></div> |
| 151 | +</div><!-- fragment --></div><!-- contents --> |
| 152 | +</div><!-- doc-content --> |
| 153 | +<!-- start footer part --> |
| 154 | +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 155 | + <ul> |
| 156 | + <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>NimBLEAttribute.h</b></li> |
| 157 | + <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> |
| 158 | + </ul> |
| 159 | +</div> |
| 160 | +</body> |
| 161 | +</html> |
0 commit comments