2021-08-05 03:02:30 +02:00
<!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" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2022-01-15 23:23:57 +01:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2021-08-05 03:02:30 +02:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2022-10-30 18:19:11 +01:00
< title > esp-nimble-cpp: /github/workspace/src/NimBLEAddress.h Source File< / title >
2021-08-05 03:02:30 +02:00
< 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 style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
2022-01-15 23:23:57 +01:00
< div id = "projectname" > esp-nimble-cpp
2022-10-30 18:19:11 +01:00
  < span id = "projectnumber" > 1.4.1< / span >
2021-08-05 03:02:30 +02:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2022-01-15 23:23:57 +01:00
<!-- Generated by Doxygen 1.9.1 -->
2021-08-05 03:02:30 +02:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_nim_b_l_e_address_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" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > NimBLEAddress.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "comment" > /*< / span > < / div >
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "comment" > * NimBLEAddress.h< / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < span class = "comment" > *< / span > < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "comment" > * Created: on Jan 24 2020< / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < span class = "comment" > * Author H2zero< / span > < / div >
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "comment" > *< / span > < / div >
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < span class = "comment" > * Originally:< / span > < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "comment" > *< / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < span class = "comment" > * BLEAddress.h< / span > < / div >
< div class = "line" > < a name = "l00010" > < / a > < span class = "lineno" > 10< / span >   < span class = "comment" > *< / span > < / div >
< div class = "line" > < a name = "l00011" > < / a > < span class = "lineno" > 11< / span >   < span class = "comment" > * Created on: Jul 2, 2017< / span > < / div >
< div class = "line" > < a name = "l00012" > < / a > < span class = "lineno" > 12< / span >   < span class = "comment" > * Author: kolban< / span > < / div >
< div class = "line" > < a name = "l00013" > < / a > < span class = "lineno" > 13< / span >   < span class = "comment" > */< / span > < / div >
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > 14< / span >   < / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < span class = "preprocessor" > #ifndef COMPONENTS_NIMBLEADDRESS_H_< / span > < / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < span class = "preprocessor" > #define COMPONENTS_NIMBLEADDRESS_H_< / span > < / div >
2022-01-15 23:23:57 +01:00
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "preprocessor" > #include " < a class = "code" href = "nimconfig_8h.html" > nimconfig.h< / a > " < / span > < / div >
2021-08-05 03:02:30 +02:00
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < span class = "preprocessor" > #if defined(CONFIG_BT_ENABLED)< / span > < / div >
< div class = "line" > < a name = "l00019" > < / a > < span class = "lineno" > 19< / span >   < / div >
2022-01-15 23:23:57 +01:00
< div class = "line" > < a name = "l00020" > < / a > < span class = "lineno" > 20< / span >   < span class = "preprocessor" > #if defined(CONFIG_NIMBLE_CPP_IDF)< / span > < / div >
< div class = "line" > < a name = "l00021" > < / a > < span class = "lineno" > 21< / span >   < span class = "preprocessor" > #include " nimble/ble.h" < / span > < / div >
< div class = "line" > < a name = "l00022" > < / a > < span class = "lineno" > 22< / span >   < span class = "preprocessor" > #else< / span > < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < span class = "preprocessor" > #include " nimble/nimble/include/nimble/ble.h" < / span > < / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < span class = "preprocessor" > #endif< / span > < / div >
2021-08-05 03:02:30 +02:00
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < / div >
2022-01-15 23:23:57 +01:00
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < span class = "comment" > /**** FIX COMPILATION ****/< / span > < / div >
< div class = "line" > < a name = "l00027" > < / a > < span class = "lineno" > 27< / span >   < span class = "preprocessor" > #undef min< / span > < / div >
< div class = "line" > < a name = "l00028" > < / a > < span class = "lineno" > 28< / span >   < span class = "preprocessor" > #undef max< / span > < / div >
< div class = "line" > < a name = "l00029" > < / a > < span class = "lineno" > 29< / span >   < span class = "comment" > /**************************/< / span > < / div >
< div class = "line" > < a name = "l00030" > < / a > < span class = "lineno" > 30< / span >   < / div >
< div class = "line" > < a name = "l00031" > < / a > < span class = "lineno" > 31< / span >   < span class = "preprocessor" > #include < string> < / span > < / div >
< div class = "line" > < a name = "l00032" > < / a > < span class = "lineno" > 32< / span >   < span class = "preprocessor" > #include < algorithm> < / span > < / div >
< div class = "line" > < a name = "l00033" > < / a > < span class = "lineno" > 33< / span >   < / div >
< div class = "line" > < a name = "l00039" > < / a > < span class = "lineno" > < a class = "line" href = "class_nim_b_l_e_address.html" > 39< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a > {< / div >
< div class = "line" > < a name = "l00040" > < / a > < span class = "lineno" > 40< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   < a class = "code" href = "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c" > NimBLEAddress< / a > ();< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < a class = "code" href = "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c" > NimBLEAddress< / a > (ble_addr_t address);< / div >
< div class = "line" > < a name = "l00043" > < / a > < span class = "lineno" > 43< / span >   < a class = "code" href = "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c" > NimBLEAddress< / a > (uint8_t address[6], uint8_t type = BLE_ADDR_PUBLIC);< / div >
< div class = "line" > < a name = "l00044" > < / a > < span class = "lineno" > 44< / span >   < a class = "code" href = "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c" > NimBLEAddress< / a > (< span class = "keyword" > const< / span > std::string & stringAddress, uint8_t type = BLE_ADDR_PUBLIC);< / div >
< div class = "line" > < a name = "l00045" > < / a > < span class = "lineno" > 45< / span >   < a class = "code" href = "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c" > NimBLEAddress< / a > (< span class = "keyword" > const< / span > uint64_t & address, uint8_t type = BLE_ADDR_PUBLIC);< / div >
< div class = "line" > < a name = "l00046" > < / a > < span class = "lineno" > 46< / span >   < span class = "keywordtype" > bool< / span > < a class = "code" href = "class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169" > equals< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a > & otherAddress) < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00047" > < / a > < span class = "lineno" > 47< / span >   < span class = "keyword" > const< / span > uint8_t* < a class = "code" href = "class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80" > getNative< / a > () < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00048" > < / a > < span class = "lineno" > 48< / span >   std::string < a class = "code" href = "class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6" > toString< / a > () < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00049" > < / a > < span class = "lineno" > 49< / span >   uint8_t < a class = "code" href = "class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb" > getType< / a > () < span class = "keyword" > const< / span > ;< / div >
2021-08-05 03:02:30 +02:00
< div class = "line" > < a name = "l00050" > < / a > < span class = "lineno" > 50< / span >   < / div >
2022-01-15 23:23:57 +01:00
< div class = "line" > < a name = "l00051" > < / a > < span class = "lineno" > 51< / span >   < span class = "keywordtype" > bool< / span > < a class = "code" href = "class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164" > operator ==< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a > & rhs) < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00052" > < / a > < span class = "lineno" > 52< / span >   < span class = "keywordtype" > bool< / span > < a class = "code" href = "class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce" > operator !=< / a > (< span class = "keyword" > const< / span > < a class = "code" href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a > & rhs) < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00053" > < / a > < span class = "lineno" > 53< / span >   < span class = "keyword" > operator< / span > std::string() < span class = "keyword" > const< / span > ;< / div >
< div class = "line" > < a name = "l00054" > < / a > < span class = "lineno" > 54< / span >   < span class = "keyword" > operator< / span > uint64_t() < span class = "keyword" > const< / span > ;< / div >
2021-08-05 03:02:30 +02:00
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   < / div >
2022-01-15 23:23:57 +01:00
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   uint8_t m_address[6];< / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   uint8_t m_addrType;< / div >
< div class = "line" > < a name = "l00059" > < / a > < span class = "lineno" > 59< / span >   };< / div >
< div class = "line" > < a name = "l00060" > < / a > < span class = "lineno" > 60< / span >   < / div >
< div class = "line" > < a name = "l00061" > < / a > < span class = "lineno" > 61< / span >   < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* CONFIG_BT_ENABLED */< / span > < span class = "preprocessor" > < / span > < / div >
< div class = "line" > < a name = "l00062" > < / a > < span class = "lineno" > 62< / span >   < span class = "preprocessor" > #endif < / span > < span class = "comment" > /* COMPONENTS_NIMBLEADDRESS_H_ */< / span > < span class = "preprocessor" > < / span > < / div >
< div class = "ttc" id = "aclass_nim_b_l_e_address_html" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a > < / div > < div class = "ttdoc" > A BLE device address.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.h:39< / div > < / div >
2021-08-05 03:02:30 +02:00
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_a18f8361ed20146cbc374a246d87015eb" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#a18f8361ed20146cbc374a246d87015eb" > NimBLEAddress::getType< / a > < / div > < div class = "ttdeci" > uint8_t getType() const< / div > < div class = "ttdoc" > Get the address type.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:136< / div > < / div >
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_a19058addb94417e2921cade37a79d04c" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#a19058addb94417e2921cade37a79d04c" > NimBLEAddress::NimBLEAddress< / a > < / div > < div class = "ttdeci" > NimBLEAddress()< / div > < div class = "ttdoc" > Create a blank address, i.e. 00:00:00:00:00:00, type 0.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:43< / div > < / div >
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_a826fe8850cbc7d54f0696b8af4637169" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#a826fe8850cbc7d54f0696b8af4637169" > NimBLEAddress::equals< / a > < / div > < div class = "ttdeci" > bool equals(const NimBLEAddress & otherAddress) const< / div > < div class = "ttdoc" > Determine if this address equals another.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:118< / div > < / div >
2022-07-31 19:38:16 +02:00
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_a87e8ccc81c2d83bf0503166939319164" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#a87e8ccc81c2d83bf0503166939319164" > NimBLEAddress::operator==< / a > < / div > < div class = "ttdeci" > bool operator==(const NimBLEAddress & rhs) const< / div > < div class = "ttdoc" > Convenience operator to check if this address is equal to another.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:161< / div > < / div >
2021-08-05 03:02:30 +02:00
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_ac53b0cc945e1505d3e72d48164ad01d6" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#ac53b0cc945e1505d3e72d48164ad01d6" > NimBLEAddress::toString< / a > < / div > < div class = "ttdeci" > std::string toString() const< / div > < div class = "ttdoc" > Convert a BLE address to a string.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:153< / div > < / div >
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_adef69a03a08303957d7e40eef07b4d80" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#adef69a03a08303957d7e40eef07b4d80" > NimBLEAddress::getNative< / a > < / div > < div class = "ttdeci" > const uint8_t * getNative() const< / div > < div class = "ttdoc" > Get the native representation of the address.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:127< / div > < / div >
2022-07-31 19:38:16 +02:00
< div class = "ttc" id = "aclass_nim_b_l_e_address_html_ae243127c78af69b26dfa225effd806ce" > < div class = "ttname" > < a href = "class_nim_b_l_e_address.html#ae243127c78af69b26dfa225effd806ce" > NimBLEAddress::operator!=< / a > < / div > < div class = "ttdeci" > bool operator!=(const NimBLEAddress & rhs) const< / div > < div class = "ttdoc" > Convenience operator to check if this address is not equal to another.< / div > < div class = "ttdef" > < b > Definition:< / b > NimBLEAddress.cpp:169< / div > < / div >
2022-01-15 23:23:57 +01:00
< div class = "ttc" id = "animconfig_8h_html" > < div class = "ttname" > < a href = "nimconfig_8h.html" > nimconfig.h< / a > < / div > < / div >
2021-08-05 03:02:30 +02:00
< / 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 > NimBLEAddress.h< / b > < / li >
2022-01-15 23:23:57 +01:00
< 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.1 < / li >
2021-08-05 03:02:30 +02:00
< / ul >
< / div >
< / body >
< / html >
