2021-08-05 01:02:30 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2024-12-15 00:45:58 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" lang = "en-US" >
2021-08-05 01:02:30 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" />
2024-12-15 00:45:58 +00:00
< meta http-equiv = "X-UA-Compatible" content = "IE=11" />
< meta name = "generator" content = "Doxygen 1.9.8" />
2021-08-05 01:02:30 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" />
2022-01-15 15:23:57 -07:00
< title > esp-nimble-cpp: NimBLEConnInfo Class Reference</ title >
2021-08-05 01:02:30 +00: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 >
2024-12-15 00:45:58 +00:00
< tr id = "projectrow" >
< td id = "projectalign" >
2025-01-13 02:22:00 +00:00
< div id = "projectname" > esp-nimble-cpp< span id = "projectnumber" >   2.1.0</ span >
2021-08-05 01:02:30 +00:00
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
2024-12-15 00:45:58 +00:00
<!-- Generated by Doxygen 1.9.8 -->
2021-08-05 01:02:30 +00:00
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox ( "searchBox" , "search/" , '.html' );
2021-08-05 01:02:30 +00:00
/* @license-end */
</ script >
< script type = "text/javascript" src = "menudata.js" ></ script >
< script type = "text/javascript" src = "menu.js" ></ script >
< script type = "text/javascript" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( function () {
initMenu ( '' , true , false , 'search.php' , 'Search' );
$ ( document ). ready ( function () { init_search (); });
});
2024-12-15 00:45:58 +00:00
/* @license-end */
</ script >
2021-08-05 01:02:30 +00:00
< 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" >
2024-12-15 00:45:58 +00:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
2021-08-05 01:02:30 +00:00
$ ( document ). ready ( function (){ initNavTree ( 'class_nim_b_l_e_conn_info.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" >
2024-12-15 00:45:58 +00:00
< 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 >
2021-08-05 01:02:30 +00:00
</ div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "class_nim_b_l_e_conn_info-members.html" > List of all members</ a > </ div >
2024-12-15 00:45:58 +00:00
< div class = "headertitle" >< div class = "title" > NimBLEConnInfo Class Reference</ div ></ div >
2021-08-05 01:02:30 +00:00
</ div > <!--header-->
< div class = "contents" >
< p > Connection information.
< a href = "class_nim_b_l_e_conn_info.html#details" > More...</ a ></ p >
2024-12-15 00:45:58 +00:00
< p >< code > #include < < a class = "el" href = "_nim_b_l_e_conn_info_8h_source.html" > NimBLEConnInfo.h</ a > > </ code ></ p >
2021-08-05 01:02:30 +00:00
< table class = "memberdecls" >
2024-12-15 00:45:58 +00:00
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a id = "pub-methods" name = "pub-methods" ></ a >
2021-08-05 01:02:30 +00:00
Public Member Functions</ h2 ></ td ></ tr >
2024-12-15 00:45:58 +00:00
< tr class = "memitem:a11564eb72e1a4d28a0430a5f13582c1f" id = "r_a11564eb72e1a4d28a0430a5f13582c1f" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a11564eb72e1a4d28a0430a5f13582c1f" name = "a11564eb72e1a4d28a0430a5f13582c1f" ></ a >
< a class = "el" href = "class_nim_b_l_e_address.html" > NimBLEAddress</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< b > getAddress</ b > () const</ td ></ tr >
< tr class = "memdesc:a11564eb72e1a4d28a0430a5f13582c1f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the over-the-air address of the connected peer. < br /></ td ></ tr >
< tr class = "separator:a11564eb72e1a4d28a0430a5f13582c1f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a18e3b5d45183c8ef20f0d2475c947442" id = "r_a18e3b5d45183c8ef20f0d2475c947442" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a18e3b5d45183c8ef20f0d2475c947442" name = "a18e3b5d45183c8ef20f0d2475c947442" ></ a >
< a class = "el" href = "class_nim_b_l_e_address.html" > NimBLEAddress</ a >   </ td >< td class = "memItemRight" valign = "bottom" >< b > getIdAddress</ b > () const</ td ></ tr >
< tr class = "memdesc:a18e3b5d45183c8ef20f0d2475c947442" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the ID address of the connected peer. < br /></ td ></ tr >
< tr class = "separator:a18e3b5d45183c8ef20f0d2475c947442" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa3ffb5995fb9961a6f04117f538a8f28" id = "r_aa3ffb5995fb9961a6f04117f538a8f28" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "aa3ffb5995fb9961a6f04117f538a8f28" name = "aa3ffb5995fb9961a6f04117f538a8f28" ></ a >
uint16_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getConnHandle</ b > () const</ td ></ tr >
< tr class = "memdesc:aa3ffb5995fb9961a6f04117f538a8f28" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the connection handle (also known as the connection id) of the connected peer. < br /></ td ></ tr >
< tr class = "separator:aa3ffb5995fb9961a6f04117f538a8f28" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aca6b24e741bcf03d4b9bdc28b008b8c6" id = "r_aca6b24e741bcf03d4b9bdc28b008b8c6" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "aca6b24e741bcf03d4b9bdc28b008b8c6" name = "aca6b24e741bcf03d4b9bdc28b008b8c6" ></ a >
uint16_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getConnInterval</ b > () const</ td ></ tr >
< tr class = "memdesc:aca6b24e741bcf03d4b9bdc28b008b8c6" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the connection interval for this connection (in 1.25ms units) < br /></ td ></ tr >
< tr class = "separator:aca6b24e741bcf03d4b9bdc28b008b8c6" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:aa8c39ebf9d346b3334b0a067ffe082a5" id = "r_aa8c39ebf9d346b3334b0a067ffe082a5" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "aa8c39ebf9d346b3334b0a067ffe082a5" name = "aa8c39ebf9d346b3334b0a067ffe082a5" ></ a >
uint16_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getConnTimeout</ b > () const</ td ></ tr >
< tr class = "memdesc:aa8c39ebf9d346b3334b0a067ffe082a5" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the supervision timeout for this connection (in 10ms units) < br /></ td ></ tr >
< tr class = "separator:aa8c39ebf9d346b3334b0a067ffe082a5" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a012bd655ebd9726762be76d30ebdb17e" id = "r_a012bd655ebd9726762be76d30ebdb17e" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a012bd655ebd9726762be76d30ebdb17e" name = "a012bd655ebd9726762be76d30ebdb17e" ></ a >
uint16_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getConnLatency</ b > () const</ td ></ tr >
< tr class = "memdesc:a012bd655ebd9726762be76d30ebdb17e" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the allowable latency for this connection (unit = number of intervals) < br /></ td ></ tr >
< tr class = "separator:a012bd655ebd9726762be76d30ebdb17e" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a17e29d0af7978f15e41933994a7a9c8f" id = "r_a17e29d0af7978f15e41933994a7a9c8f" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a17e29d0af7978f15e41933994a7a9c8f" name = "a17e29d0af7978f15e41933994a7a9c8f" ></ a >
uint16_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getMTU</ b > () const</ td ></ tr >
< tr class = "memdesc:a17e29d0af7978f15e41933994a7a9c8f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the maximum transmission unit size for this connection (in bytes) < br /></ td ></ tr >
< tr class = "separator:a17e29d0af7978f15e41933994a7a9c8f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a5f91ef30d5ff92ad26f07feb31a5cd20" id = "r_a5f91ef30d5ff92ad26f07feb31a5cd20" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a5f91ef30d5ff92ad26f07feb31a5cd20" name = "a5f91ef30d5ff92ad26f07feb31a5cd20" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > isMaster</ b > () const</ td ></ tr >
< tr class = "memdesc:a5f91ef30d5ff92ad26f07feb31a5cd20" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Check if we are in the master role in this connection. < br /></ td ></ tr >
< tr class = "separator:a5f91ef30d5ff92ad26f07feb31a5cd20" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:ad91de04bdad64019950a1d095baf0e43" id = "r_ad91de04bdad64019950a1d095baf0e43" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "ad91de04bdad64019950a1d095baf0e43" name = "ad91de04bdad64019950a1d095baf0e43" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > isSlave</ b > () const</ td ></ tr >
< tr class = "memdesc:ad91de04bdad64019950a1d095baf0e43" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Check if we are in the slave role in this connection. < br /></ td ></ tr >
< tr class = "separator:ad91de04bdad64019950a1d095baf0e43" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:afefcdd1c560a307632c15394497c436f" id = "r_afefcdd1c560a307632c15394497c436f" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "afefcdd1c560a307632c15394497c436f" name = "afefcdd1c560a307632c15394497c436f" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > isBonded</ b > () const</ td ></ tr >
< tr class = "memdesc:afefcdd1c560a307632c15394497c436f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Check if we are connected to a bonded peer. < br /></ td ></ tr >
< tr class = "separator:afefcdd1c560a307632c15394497c436f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a1a29242623a50989c7a03ee209ac2cf4" id = "r_a1a29242623a50989c7a03ee209ac2cf4" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a1a29242623a50989c7a03ee209ac2cf4" name = "a1a29242623a50989c7a03ee209ac2cf4" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > isEncrypted</ b > () const</ td ></ tr >
< tr class = "memdesc:a1a29242623a50989c7a03ee209ac2cf4" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Check if the connection in encrypted. < br /></ td ></ tr >
< tr class = "separator:a1a29242623a50989c7a03ee209ac2cf4" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a8a1174d706ae36e99adc9498bf30d68f" id = "r_a8a1174d706ae36e99adc9498bf30d68f" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a8a1174d706ae36e99adc9498bf30d68f" name = "a8a1174d706ae36e99adc9498bf30d68f" ></ a >
bool  </ td >< td class = "memItemRight" valign = "bottom" >< b > isAuthenticated</ b > () const</ td ></ tr >
< tr class = "memdesc:a8a1174d706ae36e99adc9498bf30d68f" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Check if the the connection has been authenticated. < br /></ td ></ tr >
< tr class = "separator:a8a1174d706ae36e99adc9498bf30d68f" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:a3a555ccfc6fe678a2603942022a8cd5c" id = "r_a3a555ccfc6fe678a2603942022a8cd5c" >< td class = "memItemLeft" align = "right" valign = "top" >< a id = "a3a555ccfc6fe678a2603942022a8cd5c" name = "a3a555ccfc6fe678a2603942022a8cd5c" ></ a >
uint8_t  </ td >< td class = "memItemRight" valign = "bottom" >< b > getSecKeySize</ b > () const</ td ></ tr >
< tr class = "memdesc:a3a555ccfc6fe678a2603942022a8cd5c" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Gets the key size used to encrypt the connection. < br /></ td ></ tr >
< tr class = "separator:a3a555ccfc6fe678a2603942022a8cd5c" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-08-05 01:02:30 +00:00
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > Connection information. </ p >
</ 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_conn_info.html" > NimBLEConnInfo</ a ></ li >
2024-12-15 00:45:58 +00: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.8 </ li >
2021-08-05 01:02:30 +00:00
</ ul >
</ div >
</ body >
</ html >
