<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qlowenergyconnectionparameters.cpp -->
<title>QLowEnergyConnectionParameters Class | Qt Bluetooth 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtbluetooth-index.html">Qt Bluetooth</a></td><td ><a href="qtbluetooth-module.html">C++ Classes</a></td><td >QLowEnergyConnectionParameters</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtbluetooth-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QLowEnergyConnectionParameters Class</h1>
<!-- $$$QLowEnergyConnectionParameters-brief -->
<p>The <a href="qlowenergyconnectionparameters.html">QLowEnergyConnectionParameters</a> class is used when requesting or reporting an update of the parameters of a Bluetooth LE connection. <a href="#details">More...</a></p>
<!-- @@@QLowEnergyConnectionParameters -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QLowEnergyConnectionParameters></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += bluetooth</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr></table></div><ul>
<li><a href="qlowenergyconnectionparameters-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#QLowEnergyConnectionParameters">QLowEnergyConnectionParameters</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#QLowEnergyConnectionParameters-1">QLowEnergyConnectionParameters</a></b>(const QLowEnergyConnectionParameters &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#dtor.QLowEnergyConnectionParameters">~QLowEnergyConnectionParameters</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#latency">latency</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#maximumInterval">maximumInterval</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> double </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#minimumInterval">minimumInterval</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#setIntervalRange">setIntervalRange</a></b>(double <i>minimum</i>, double <i>maximum</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#setLatency">setLatency</a></b>(int <i>latency</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#setSupervisionTimeout">setSupervisionTimeout</a></b>(int <i>timeout</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#supervisionTimeout">supervisionTimeout</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#swap">swap</a></b>(QLowEnergyConnectionParameters &<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLowEnergyConnectionParameters &</td><td class="memItemRight bottomAlign"><b><a href="qlowenergyconnectionparameters.html#operator-eq">operator=</a></b>(const QLowEnergyConnectionParameters &<i>other</i>)</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QLowEnergyConnectionParameters-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qlowenergyconnectionparameters.html">QLowEnergyConnectionParameters</a> class is used when requesting or reporting an update of the parameters of a Bluetooth LE connection.</p>
<p>The connection parameters influence how often a master and a slave device synchronize with each other. In general, a lower connection interval and latency means faster communication, but also higher power consumption. How these criteria should be weighed against each other is highly dependent on the concrete use case.</p>
<p>Android only indirectly permits the adjustment of this parameter set. The platform separates the connection parameters into three categories (hight, low & balanced priority). Each category implies a predefined set of values for <a href="qlowenergyconnectionparameters.html#minimumInterval">minimumInterval</a>(), <a href="qlowenergyconnectionparameters.html#maximumInterval">maximumInterval</a>() and <a href="qlowenergyconnectionparameters.html#latency">latency</a>(). Additionally, the value ranges of each category can vary from one Android device to the next. Qt uses the <a href="qlowenergyconnectionparameters.html#minimumInterval">minimumInterval</a>() to determine the target category as follows:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th ><a href="qlowenergyconnectionparameters.html#minimumInterval">minimumInterval</a>()</th><th >Android priority</th></tr></thead>
<tr valign="top" class="odd"><td >interval < 30</td><td >CONNECTION_PRIORITY_HIGH</td></tr>
<tr valign="top" class="even"><td >30 <= interval <= 100</td><td >CONNECTION_PRIORITY_BALANCED</td></tr>
<tr valign="top" class="odd"><td >interval > 100</td><td >CONNECTION_PRIORITY_LOW_POWER</td></tr>
</table></div>
<p>The <a href="qlowenergyconnectionparameters.html#supervisionTimeout">supervisionTimeout</a>() cannot be changed on Android and is therefore ignored.</p>
</div>
<p><b>See also </b><a href="qlowenergycontroller.html#requestConnectionUpdate">QLowEnergyController::requestConnectionUpdate</a> and <a href="qlowenergycontroller.html#connectionUpdated">QLowEnergyController::connectionUpdated</a>.</p>
<!-- @@@QLowEnergyConnectionParameters -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QLowEnergyConnectionParameters[overload1]$$$QLowEnergyConnectionParameters -->
<h3 class="fn" id="QLowEnergyConnectionParameters"><a name="QLowEnergyConnectionParameters"></a>QLowEnergyConnectionParameters::<span class="name">QLowEnergyConnectionParameters</span>()</h3>
<p>Constructs a new object of this class. All values are initialized to valid defaults.</p>
<!-- @@@QLowEnergyConnectionParameters -->
<!-- $$$QLowEnergyConnectionParameters$$$QLowEnergyConnectionParametersconstQLowEnergyConnectionParameters& -->
<h3 class="fn" id="QLowEnergyConnectionParameters-1"><a name="QLowEnergyConnectionParameters-1"></a>QLowEnergyConnectionParameters::<span class="name">QLowEnergyConnectionParameters</span>(const <span class="type"><a href="qlowenergyconnectionparameters.html#QLowEnergyConnectionParameters">QLowEnergyConnectionParameters</a></span> &<i>other</i>)</h3>
<p>Constructs a new object of this class that is a copy of <i>other</i>.</p>
<!-- @@@QLowEnergyConnectionParameters -->
<!-- $$$~QLowEnergyConnectionParameters[overload1]$$$~QLowEnergyConnectionParameters -->
<h3 class="fn" id="dtor.QLowEnergyConnectionParameters"><a name="dtor.QLowEnergyConnectionParameters"></a>QLowEnergyConnectionParameters::<span class="name">~QLowEnergyConnectionParameters</span>()</h3>
<p>Destroys this object.</p>
<!-- @@@~QLowEnergyConnectionParameters -->
<!-- $$$latency[overload1]$$$latency -->
<h3 class="fn" id="latency"><a name="latency"></a><span class="type">int</span> QLowEnergyConnectionParameters::<span class="name">latency</span>() const</h3>
<p>Returns the slave latency of the connection.</p>
<p><b>See also </b><a href="qlowenergyconnectionparameters.html#setLatency">setLatency</a>().</p>
<!-- @@@latency -->
<!-- $$$maximumInterval[overload1]$$$maximumInterval -->
<h3 class="fn" id="maximumInterval"><a name="maximumInterval"></a><span class="type">double</span> QLowEnergyConnectionParameters::<span class="name">maximumInterval</span>() const</h3>
<p>Returns the maximum connection interval in milliseconds. The default is 4000.</p>
<p><b>Note: </b>If this object was emitted via <a href="qlowenergycontroller.html#connectionUpdated">QLowEnergyController::connectionUpdated</a>(), then this value is the same as <a href="qlowenergyconnectionparameters.html#minimumInterval">minimumInterval</a>() and refers to the actual connection interval.</p><p><b>See also </b><a href="qlowenergyconnectionparameters.html#setIntervalRange">setIntervalRange</a>().</p>
<!-- @@@maximumInterval -->
<!-- $$$minimumInterval[overload1]$$$minimumInterval -->
<h3 class="fn" id="minimumInterval"><a name="minimumInterval"></a><span class="type">double</span> QLowEnergyConnectionParameters::<span class="name">minimumInterval</span>() const</h3>
<p>Returns the minimum connection interval in milliseconds. The default is 7.5.</p>
<p><b>Note: </b>If this object was emitted via <a href="qlowenergycontroller.html#connectionUpdated">QLowEnergyController::connectionUpdated</a>(), then this value is the same as <a href="qlowenergyconnectionparameters.html#maximumInterval">maximumInterval</a>() and refers to the actual connection interval.</p><p><b>See also </b><a href="qlowenergyconnectionparameters.html#setIntervalRange">setIntervalRange</a>().</p>
<!-- @@@minimumInterval -->
<!-- $$$setIntervalRange[overload1]$$$setIntervalRangedoubledouble -->
<h3 class="fn" id="setIntervalRange"><a name="setIntervalRange"></a><span class="type">void</span> QLowEnergyConnectionParameters::<span class="name">setIntervalRange</span>(<span class="type">double</span> <i>minimum</i>, <span class="type">double</span> <i>maximum</i>)</h3>
<p>Sets the range in which the connection interval should be. The actual value will be decided by the controller. Both <i>minimum</i> and <i>maximum</i> are given in milliseconds. If <i>maximum</i> is smaller than <i>minimum</i>, it will be set to the value of <i>minimum</i>. The smallest possible connection interval is 7.5 milliseconds, the largest one is 4000 milliseconds.</p>
<p><b>See also </b><a href="qlowenergyconnectionparameters.html#minimumInterval">minimumInterval</a>() and <a href="qlowenergyconnectionparameters.html#maximumInterval">maximumInterval</a>().</p>
<!-- @@@setIntervalRange -->
<!-- $$$setLatency[overload1]$$$setLatencyint -->
<h3 class="fn" id="setLatency"><a name="setLatency"></a><span class="type">void</span> QLowEnergyConnectionParameters::<span class="name">setLatency</span>(<span class="type">int</span> <i>latency</i>)</h3>
<p>Sets the slave latency of the connection (that is, the number of connection events that a slave device is allowed to ignore) to <i>latency</i>. The minimum value is 0, the maximum is 499.</p>
<p><b>See also </b><a href="qlowenergyconnectionparameters.html#latency">latency</a>().</p>
<!-- @@@setLatency -->
<!-- $$$setSupervisionTimeout[overload1]$$$setSupervisionTimeoutint -->
<h3 class="fn" id="setSupervisionTimeout"><a name="setSupervisionTimeout"></a><span class="type">void</span> QLowEnergyConnectionParameters::<span class="name">setSupervisionTimeout</span>(<span class="type">int</span> <i>timeout</i>)</h3>
<p>Sets the link supervision timeout to <i>timeout</i> milliseconds. There are several constraints on this value: It must be in the range [100,32000] and it must be larger than (1 + <a href="qlowenergyconnectionparameters.html#latency">latency</a>()) * 2 * <a href="qlowenergyconnectionparameters.html#maximumInterval">maximumInterval</a>().</p>
<p>On Android, this timeout is not adjustable and therefore ignored.</p>
<p><b>See also </b><a href="qlowenergyconnectionparameters.html#supervisionTimeout">supervisionTimeout</a>().</p>
<!-- @@@setSupervisionTimeout -->
<!-- $$$supervisionTimeout[overload1]$$$supervisionTimeout -->
<h3 class="fn" id="supervisionTimeout"><a name="supervisionTimeout"></a><span class="type">int</span> QLowEnergyConnectionParameters::<span class="name">supervisionTimeout</span>() const</h3>
<p>Returns the link supervision timeout of the connection in milliseconds.</p>
<p><b>See also </b><a href="qlowenergyconnectionparameters.html#setSupervisionTimeout">setSupervisionTimeout</a>().</p>
<!-- @@@supervisionTimeout -->
<!-- $$$swap[overload1]$$$swapQLowEnergyConnectionParameters& -->
<h3 class="fn" id="swap"><a name="swap"></a><span class="type">void</span> QLowEnergyConnectionParameters::<span class="name">swap</span>(<span class="type"><a href="qlowenergyconnectionparameters.html#QLowEnergyConnectionParameters">QLowEnergyConnectionParameters</a></span> &<i>other</i>)</h3>
<p>Swaps this object with <i>other</i>.</p>
<!-- @@@swap -->
<!-- $$$operator=[overload1]$$$operator=constQLowEnergyConnectionParameters& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qlowenergyconnectionparameters.html#QLowEnergyConnectionParameters">QLowEnergyConnectionParameters</a></span> &QLowEnergyConnectionParameters::<span class="name">operator=</span>(const <span class="type"><a href="qlowenergyconnectionparameters.html#QLowEnergyConnectionParameters">QLowEnergyConnectionParameters</a></span> &<i>other</i>)</h3>
<p>Makes this object a copy of <i>other</i> and returns the new value of this object.</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
