esp-nimble-cpp/class_nim_b_l_e_descriptor.html

<!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: NimBLEDescriptor 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>
<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.1.0</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>
</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('class_nim_b_l_e_descriptor.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_nim_b_l_e_descriptor-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">NimBLEDescriptor Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A model of a BLE descriptor.  
 <a href="class_nim_b_l_e_descriptor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_nim_b_l_e_descriptor_8h_source.html">NimBLEDescriptor.h</a>&gt;</code></p>

<p>Inherits NimBLELocalValueAttribute.</p>

<p>Inherited by <a class="el" href="class_nim_b_l_e2904.html">NimBLE2904</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acdae256772e6ba433df5ff3217335a1b" id="r_acdae256772e6ba433df5ff3217335a1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#acdae256772e6ba433df5ff3217335a1b">NimBLEDescriptor</a> (const char *uuid, uint16_t properties, uint16_t maxLen, <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic=nullptr)</td></tr>
<tr class="memdesc:acdae256772e6ba433df5ff3217335a1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a descriptor.  <br /></td></tr>
<tr class="separator:acdae256772e6ba433df5ff3217335a1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b371ae4807648762cad1346ba6fd3c3" id="r_a9b371ae4807648762cad1346ba6fd3c3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a9b371ae4807648762cad1346ba6fd3c3">NimBLEDescriptor</a> (const <a class="el" href="class_nim_b_l_e_u_u_i_d.html">NimBLEUUID</a> &amp;uuid, uint16_t properties, uint16_t maxLen, <a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *pCharacteristic=nullptr)</td></tr>
<tr class="memdesc:a9b371ae4807648762cad1346ba6fd3c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct a descriptor.  <br /></td></tr>
<tr class="separator:a9b371ae4807648762cad1346ba6fd3c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83b589a2022bbd86743b0ee4c3670a37" id="r_a83b589a2022bbd86743b0ee4c3670a37"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#a83b589a2022bbd86743b0ee4c3670a37">toString</a> () const</td></tr>
<tr class="memdesc:a83b589a2022bbd86743b0ee4c3670a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a string representation of the descriptor.  <br /></td></tr>
<tr class="separator:a83b589a2022bbd86743b0ee4c3670a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9cb8727f9e17cf8050cf619e5fe3096" id="r_aa9cb8727f9e17cf8050cf619e5fe3096"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#aa9cb8727f9e17cf8050cf619e5fe3096">setCallbacks</a> (<a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> *pCallbacks)</td></tr>
<tr class="memdesc:aa9cb8727f9e17cf8050cf619e5fe3096"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the callback handlers for this descriptor.  <br /></td></tr>
<tr class="separator:aa9cb8727f9e17cf8050cf619e5fe3096"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa61b5f14156e9f378688ec875cf48309" id="r_aa61b5f14156e9f378688ec875cf48309"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_nim_b_l_e_descriptor.html#aa61b5f14156e9f378688ec875cf48309">getCharacteristic</a> () const</td></tr>
<tr class="memdesc:aa61b5f14156e9f378688ec875cf48309"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the characteristic this descriptor belongs to.  <br /></td></tr>
<tr class="separator:aa61b5f14156e9f378688ec875cf48309"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A model of a BLE descriptor. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acdae256772e6ba433df5ff3217335a1b" name="acdae256772e6ba433df5ff3217335a1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acdae256772e6ba433df5ff3217335a1b">&#9670;&#160;</a></span>NimBLEDescriptor() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">NimBLEDescriptor::NimBLEDescriptor </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>uuid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>properties</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>max_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
          <td class="paramname"><em>pCharacteristic</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct a descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>- UUID (const char*) for the descriptor. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">properties</td><td>- Properties for the descriptor. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>- The maximum length in bytes that the descriptor value can hold. (Default: 512 bytes for esp32, 20 for all others). </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>- pointer to the characteristic instance this descriptor belongs to. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a9b371ae4807648762cad1346ba6fd3c3" name="a9b371ae4807648762cad1346ba6fd3c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b371ae4807648762cad1346ba6fd3c3">&#9670;&#160;</a></span>NimBLEDescriptor() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">NimBLEDescriptor::NimBLEDescriptor </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></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>properties</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>max_len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> *&#160;</td>
          <td class="paramname"><em>pCharacteristic</em> = <code>nullptr</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct a descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uuid</td><td>- UUID (const char*) for the descriptor. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">properties</td><td>- Properties for the descriptor. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>- The maximum length in bytes that the descriptor value can hold. (Default: 512 bytes for esp32, 20 for all others). </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pCharacteristic</td><td>- pointer to the characteristic instance this descriptor belongs to. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa61b5f14156e9f378688ec875cf48309" name="aa61b5f14156e9f378688ec875cf48309"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa61b5f14156e9f378688ec875cf48309">&#9670;&#160;</a></span>getCharacteristic()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_nim_b_l_e_characteristic.html">NimBLECharacteristic</a> * NimBLEDescriptor::getCharacteristic </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the characteristic this descriptor belongs to. </p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the characteristic this descriptor belongs to. </dd></dl>

</div>
</div>
<a id="aa9cb8727f9e17cf8050cf619e5fe3096" name="aa9cb8727f9e17cf8050cf619e5fe3096"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9cb8727f9e17cf8050cf619e5fe3096">&#9670;&#160;</a></span>setCallbacks()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void NimBLEDescriptor::setCallbacks </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html">NimBLEDescriptorCallbacks</a> *&#160;</td>
          <td class="paramname"><em>pCallbacks</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the callback handlers for this descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pCallbacks</td><td>An instance of a callback structure used to define any callbacks for the descriptor. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a83b589a2022bbd86743b0ee4c3670a37" name="a83b589a2022bbd86743b0ee4c3670a37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83b589a2022bbd86743b0ee4c3670a37">&#9670;&#160;</a></span>toString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string NimBLEDescriptor::toString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return a string representation of the descriptor. </p>
<dl class="section return"><dt>Returns</dt><dd>A string representation of the descriptor. </dd></dl>

</div>
</div>
</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="class_nim_b_l_e_descriptor.html">NimBLEDescriptor</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.8 </li>
  </ul>
</div>
</body>
</html>