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-01-15 23:23:57 +01:00
< title > esp-nimble-cpp: NimBLEConnInfo Class Reference< / 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-07-31 19:38:16 +02:00
  < span id = "projectnumber" > 1.4.0< / 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('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" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / 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 >
< div class = "headertitle" >
< div class = "title" > NimBLEConnInfo Class Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > Connection information.
< a href = "class_nim_b_l_e_conn_info.html#details" > More...< / a > < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:af17023ca06c3d1b9e142dcd5f8c54847" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "af17023ca06c3d1b9e142dcd5f8c54847" > < / a >
< a class = "el" href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#af17023ca06c3d1b9e142dcd5f8c54847" > getAddress< / a > ()< / td > < / tr >
< tr class = "memdesc:af17023ca06c3d1b9e142dcd5f8c54847" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the over-the-air address of the connected peer. < br / > < / td > < / tr >
< tr class = "separator:af17023ca06c3d1b9e142dcd5f8c54847" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7bc23f09eb7dd53be902cb67d2ba745a" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a7bc23f09eb7dd53be902cb67d2ba745a" > < / a >
< a class = "el" href = "class_nim_b_l_e_address.html" > NimBLEAddress< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a7bc23f09eb7dd53be902cb67d2ba745a" > getIdAddress< / a > ()< / td > < / tr >
< tr class = "memdesc:a7bc23f09eb7dd53be902cb67d2ba745a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the ID address of the connected peer. < br / > < / td > < / tr >
< tr class = "separator:a7bc23f09eb7dd53be902cb67d2ba745a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a77e212f3e236b05da0978ea482e3efb4" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a77e212f3e236b05da0978ea482e3efb4" > < / a >
uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a77e212f3e236b05da0978ea482e3efb4" > getConnHandle< / a > ()< / td > < / tr >
< tr class = "memdesc:a77e212f3e236b05da0978ea482e3efb4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the connection handle of the connected peer. < br / > < / td > < / tr >
< tr class = "separator:a77e212f3e236b05da0978ea482e3efb4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:aa43374d84b7564f6d187fd0c637b1049" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "aa43374d84b7564f6d187fd0c637b1049" > < / a >
uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#aa43374d84b7564f6d187fd0c637b1049" > getConnInterval< / a > ()< / td > < / tr >
< tr class = "memdesc:aa43374d84b7564f6d187fd0c637b1049" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the connection interval for this connection (in 1.25ms units) < br / > < / td > < / tr >
< tr class = "separator:aa43374d84b7564f6d187fd0c637b1049" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8e885d340f1ab4e477c69ed7ea99b082" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a8e885d340f1ab4e477c69ed7ea99b082" > < / a >
uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a8e885d340f1ab4e477c69ed7ea99b082" > getConnTimeout< / a > ()< / td > < / tr >
< tr class = "memdesc:a8e885d340f1ab4e477c69ed7ea99b082" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the supervision timeout for this connection (in 10ms units) < br / > < / td > < / tr >
< tr class = "separator:a8e885d340f1ab4e477c69ed7ea99b082" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a10c6093ca2f92ea61b82815909106430" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a10c6093ca2f92ea61b82815909106430" > < / a >
uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a10c6093ca2f92ea61b82815909106430" > getConnLatency< / a > ()< / td > < / tr >
< tr class = "memdesc:a10c6093ca2f92ea61b82815909106430" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the allowable latency for this connection (unit = number of intervals) < br / > < / td > < / tr >
< tr class = "separator:a10c6093ca2f92ea61b82815909106430" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a94796b6446ef40c0ae0d1f8af1ff9462" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a94796b6446ef40c0ae0d1f8af1ff9462" > < / a >
uint16_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a94796b6446ef40c0ae0d1f8af1ff9462" > getMTU< / a > ()< / td > < / tr >
< tr class = "memdesc:a94796b6446ef40c0ae0d1f8af1ff9462" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the maximum transmission unit size for this connection (in bytes) < br / > < / td > < / tr >
< tr class = "separator:a94796b6446ef40c0ae0d1f8af1ff9462" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a63ff245a8848bf1cc5839adee7aa41c4" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a63ff245a8848bf1cc5839adee7aa41c4" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a63ff245a8848bf1cc5839adee7aa41c4" > isMaster< / a > ()< / td > < / tr >
< tr class = "memdesc:a63ff245a8848bf1cc5839adee7aa41c4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if we are in the master role in this connection. < br / > < / td > < / tr >
< tr class = "separator:a63ff245a8848bf1cc5839adee7aa41c4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:abfb91b833cb200f795bc63d5affff6af" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "abfb91b833cb200f795bc63d5affff6af" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#abfb91b833cb200f795bc63d5affff6af" > isSlave< / a > ()< / td > < / tr >
< tr class = "memdesc:abfb91b833cb200f795bc63d5affff6af" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if we are in the slave role in this connection. < br / > < / td > < / tr >
< tr class = "separator:abfb91b833cb200f795bc63d5affff6af" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:af281a25921d36dc75cf1e37561940125" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "af281a25921d36dc75cf1e37561940125" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#af281a25921d36dc75cf1e37561940125" > isBonded< / a > ()< / td > < / tr >
< tr class = "memdesc:af281a25921d36dc75cf1e37561940125" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if we are connected to a bonded peer. < br / > < / td > < / tr >
< tr class = "separator:af281a25921d36dc75cf1e37561940125" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a8ecf3c58da6ffb529215ce6f13c96744" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a8ecf3c58da6ffb529215ce6f13c96744" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a8ecf3c58da6ffb529215ce6f13c96744" > isEncrypted< / a > ()< / td > < / tr >
< tr class = "memdesc:a8ecf3c58da6ffb529215ce6f13c96744" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if the connection in encrypted. < br / > < / td > < / tr >
< tr class = "separator:a8ecf3c58da6ffb529215ce6f13c96744" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a7229e53d21c9c6b5b9fb5bd232862c89" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a7229e53d21c9c6b5b9fb5bd232862c89" > < / a >
bool  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a7229e53d21c9c6b5b9fb5bd232862c89" > isAuthenticated< / a > ()< / td > < / tr >
< tr class = "memdesc:a7229e53d21c9c6b5b9fb5bd232862c89" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Check if the the connection has been authenticated. < br / > < / td > < / tr >
< tr class = "separator:a7229e53d21c9c6b5b9fb5bd232862c89" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a278a8456f9d7df9cea7d776e61b36782" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "a278a8456f9d7df9cea7d776e61b36782" > < / a >
uint8_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "class_nim_b_l_e_conn_info.html#a278a8456f9d7df9cea7d776e61b36782" > getSecKeySize< / a > ()< / td > < / tr >
< tr class = "memdesc:a278a8456f9d7df9cea7d776e61b36782" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Gets the key size used to encrypt the connection. < br / > < / td > < / tr >
< tr class = "separator:a278a8456f9d7df9cea7d776e61b36782" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / 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 >
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 >
