esp-nimble-cpp/annotated.html

143 lines
15 KiB
HTML
Raw Normal View 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"/>
2022-01-15 23:23:57 +01:00
<title>esp-nimble-cpp: Class List</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>
</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('annotated.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">Class List</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e2904.html" target="_self">NimBLE2904</a></td><td class="desc">Descriptor for Characteristic Presentation Format </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_address.html" target="_self">NimBLEAddress</a></td><td class="desc">A BLE device address </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertised_device.html" target="_self">NimBLEAdvertisedDevice</a></td><td class="desc">A representation of a BLE advertised device found by a scan </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertisement_data.html" target="_self">NimBLEAdvertisementData</a></td><td class="desc">Advertisement data set by the programmer to be published by the BLE server </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_advertising.html" target="_self">NimBLEAdvertising</a></td><td class="desc">Perform and manage BLE advertising </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_attribute.html" target="_self">NimBLEAttribute</a></td><td class="desc">A base class for BLE attributes </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_att_value.html" target="_self">NimBLEAttValue</a></td><td class="desc">A specialized container class to hold BLE attribute values </td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_beacon.html" target="_self">NimBLEBeacon</a></td><td class="desc">Representation of a beacon. See: </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_characteristic.html" target="_self">NimBLECharacteristic</a></td><td class="desc">The model of a BLE Characteristic </td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_characteristic_callbacks.html" target="_self">NimBLECharacteristicCallbacks</a></td><td class="desc">Callbacks that can be associated with a BLE characteristic to inform of events </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_client.html" target="_self">NimBLEClient</a></td><td class="desc">A model of a BLE client </td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_client_callbacks.html" target="_self">NimBLEClientCallbacks</a></td><td class="desc">Callbacks associated with a BLE client </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_conn_info.html" target="_self">NimBLEConnInfo</a></td><td class="desc">Connection information </td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_descriptor.html" target="_self">NimBLEDescriptor</a></td><td class="desc">A model of a BLE descriptor </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_descriptor_callbacks.html" target="_self">NimBLEDescriptorCallbacks</a></td><td class="desc">Callbacks that can be associated with a BLE descriptors to inform of events </td></tr>
<tr id="row_15_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_device.html" target="_self">NimBLEDevice</a></td><td class="desc">A model of a BLE Device from which all the BLE roles are created </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_eddystone_t_l_m.html" target="_self">NimBLEEddystoneTLM</a></td><td class="desc">Representation of a beacon. See: </td></tr>
<tr id="row_17_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_ext_advertisement.html" target="_self">NimBLEExtAdvertisement</a></td><td class="desc">Extended advertisement data </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_ext_advertising.html" target="_self">NimBLEExtAdvertising</a></td><td class="desc">Extended advertising class </td></tr>
<tr id="row_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_ext_advertising_callbacks.html" target="_self">NimBLEExtAdvertisingCallbacks</a></td><td class="desc">Callbacks associated with <a class="el" href="class_nim_b_l_e_ext_advertising.html" title="Extended advertising class.">NimBLEExtAdvertising</a> class </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_h_i_d_device.html" target="_self">NimBLEHIDDevice</a></td><td class="desc">A model of a BLE Human Interface Device </td></tr>
<tr id="row_21_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_local_attribute.html" target="_self">NimBLELocalAttribute</a></td><td class="desc">A base class for local BLE attributes </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_remote_characteristic.html" target="_self">NimBLERemoteCharacteristic</a></td><td class="desc">A model of a remote BLE characteristic </td></tr>
<tr id="row_23_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_remote_descriptor.html" target="_self">NimBLERemoteDescriptor</a></td><td class="desc">A model of remote BLE descriptor </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_remote_service.html" target="_self">NimBLERemoteService</a></td><td class="desc">A model of a remote BLE service </td></tr>
<tr id="row_25_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_scan.html" target="_self">NimBLEScan</a></td><td class="desc">Perform and manage BLE scans </td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_scan_callbacks.html" target="_self">NimBLEScanCallbacks</a></td><td class="desc">A callback handler for callbacks associated device scanning </td></tr>
<tr id="row_27_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_scan_results.html" target="_self">NimBLEScanResults</a></td><td class="desc">A class that contains and operates on the results of a BLE scan </td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_server.html" target="_self">NimBLEServer</a></td><td class="desc">The model of a BLE server </td></tr>
<tr id="row_29_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_server_callbacks.html" target="_self">NimBLEServerCallbacks</a></td><td class="desc">Callbacks associated with the operation of a BLE server </td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_service.html" target="_self">NimBLEService</a></td><td class="desc">The model of a BLE service </td></tr>
<tr id="row_31_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_nim_b_l_e_task_data.html" target="_self">NimBLETaskData</a></td><td class="desc">A structure to hold data for a task that is waiting for a response </td></tr>
2022-07-31 19:38:16 +02:00
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_utils.html" target="_self">NimBLEUtils</a></td><td class="desc">A BLE Utility class with methods for debugging and general purpose use </td></tr>
<tr id="row_33_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_nim_b_l_e_u_u_i_d.html" target="_self">NimBLEUUID</a></td><td class="desc">A model of a BLE UUID </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>