/usr/share/doc/buteo-syncfw-doc/classBackgroundSync.html is in libbuteosyncfw5-doc 0.7.21+16.04.20151216.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>ButeoSynchronizationFramework: BackgroundSync Class Reference</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="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 style="padding-left: 0.5em;">
<div id="projectname">ButeoSynchronizationFramework
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-slots">Public Slots</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classBackgroundSync-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BackgroundSync Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classBackgroundSync.html" title="BackgroundSync implementation. ">BackgroundSync</a> implementation.
<a href="classBackgroundSync.html#details">More...</a></p>
<p><code>#include <<a class="el" href="BackgroundSync_8h_source.html">BackgroundSync.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for BackgroundSync:</div>
<div class="dyncontent">
<div class="center">
<img src="classBackgroundSync.png" usemap="#BackgroundSync_map" alt=""/>
<map id="BackgroundSync_map" name="BackgroundSync_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr class="memitem:a492f9f7ba84e6a42799de847acc1815b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#a492f9f7ba84e6a42799de847acc1815b">onBackgroundSyncCompleted</a> (QString aProfName)</td></tr>
<tr class="memdesc:a492f9f7ba84e6a42799de847acc1815b"><td class="mdescLeft"> </td><td class="mdescRight">Called when background sync is completed. <a href="#a492f9f7ba84e6a42799de847acc1815b">More...</a><br /></td></tr>
<tr class="separator:a492f9f7ba84e6a42799de847acc1815b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="signals"></a>
Signals</h2></td></tr>
<tr class="memitem:adba0bbba28cdc4d5870d55e48edadfe1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#adba0bbba28cdc4d5870d55e48edadfe1">onBackgroundSyncRunning</a> (QString aProfName)</td></tr>
<tr class="memdesc:adba0bbba28cdc4d5870d55e48edadfe1"><td class="mdescLeft"> </td><td class="mdescRight">This signal will be emitted when a background sync timer for particular profile is triggered. <a href="#adba0bbba28cdc4d5870d55e48edadfe1">More...</a><br /></td></tr>
<tr class="separator:adba0bbba28cdc4d5870d55e48edadfe1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6a2691e2bea24eaff41289255aa500d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#ab6a2691e2bea24eaff41289255aa500d">onBackgroundSwitchRunning</a> (const QString &aProfName)</td></tr>
<tr class="memdesc:ab6a2691e2bea24eaff41289255aa500d"><td class="mdescLeft"> </td><td class="mdescRight">This signal will be emitted when a switch timer for particular profile is triggered. <a href="#ab6a2691e2bea24eaff41289255aa500d">More...</a><br /></td></tr>
<tr class="separator:ab6a2691e2bea24eaff41289255aa500d"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a87f8d43ef5d56eb52c8d486327b9dd07"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#a87f8d43ef5d56eb52c8d486327b9dd07">BackgroundSync</a> (QObject *aParent)</td></tr>
<tr class="memdesc:a87f8d43ef5d56eb52c8d486327b9dd07"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a87f8d43ef5d56eb52c8d486327b9dd07">More...</a><br /></td></tr>
<tr class="separator:a87f8d43ef5d56eb52c8d486327b9dd07"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a955ea823c7b95bf137257dda12c514e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a955ea823c7b95bf137257dda12c514e0"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#a955ea823c7b95bf137257dda12c514e0">~BackgroundSync</a> ()</td></tr>
<tr class="memdesc:a955ea823c7b95bf137257dda12c514e0"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a955ea823c7b95bf137257dda12c514e0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0d8a40e12763c2dbff0f44cde445391"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#ac0d8a40e12763c2dbff0f44cde445391">set</a> (const QString &aProfName, int seconds)</td></tr>
<tr class="memdesc:ac0d8a40e12763c2dbff0f44cde445391"><td class="mdescLeft"> </td><td class="mdescRight">Schedules a background sync for this profile. <a href="#ac0d8a40e12763c2dbff0f44cde445391">More...</a><br /></td></tr>
<tr class="separator:ac0d8a40e12763c2dbff0f44cde445391"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af4f6f3a67195da140be8273b823edd13"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#af4f6f3a67195da140be8273b823edd13">remove</a> (const QString &aProfName)</td></tr>
<tr class="memdesc:af4f6f3a67195da140be8273b823edd13"><td class="mdescLeft"> </td><td class="mdescRight">Removes background sync for a profile. <a href="#af4f6f3a67195da140be8273b823edd13">More...</a><br /></td></tr>
<tr class="separator:af4f6f3a67195da140be8273b823edd13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac469d2e745830b931e77240c88a3a3d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac469d2e745830b931e77240c88a3a3d9"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#ac469d2e745830b931e77240c88a3a3d9">removeAll</a> ()</td></tr>
<tr class="memdesc:ac469d2e745830b931e77240c88a3a3d9"><td class="mdescLeft"> </td><td class="mdescRight">Removes all background syncs for all profiles. <br /></td></tr>
<tr class="separator:ac469d2e745830b931e77240c88a3a3d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae293ec7bd6e44b0ffb3ade6476259f7c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#ae293ec7bd6e44b0ffb3ade6476259f7c">setSwitch</a> (const QString &aProfName, const QDateTime &aSwitchTime)</td></tr>
<tr class="memdesc:ae293ec7bd6e44b0ffb3ade6476259f7c"><td class="mdescLeft"> </td><td class="mdescRight">Schedules a switch(rush/off-rush) for a background sync running for this profile, the switch should be added after the background activity. <a href="#ae293ec7bd6e44b0ffb3ade6476259f7c">More...</a><br /></td></tr>
<tr class="separator:ae293ec7bd6e44b0ffb3ade6476259f7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad06d33838f34231621095e7e932c361e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBackgroundSync.html#ad06d33838f34231621095e7e932c361e">removeSwitch</a> (const QString &aProfName)</td></tr>
<tr class="memdesc:ad06d33838f34231621095e7e932c361e"><td class="mdescLeft"> </td><td class="mdescRight">Removes a switch(rush/off-rush) for a profile. <a href="#ad06d33838f34231621095e7e932c361e">More...</a><br /></td></tr>
<tr class="separator:ad06d33838f34231621095e7e932c361e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classBackgroundSync.html" title="BackgroundSync implementation. ">BackgroundSync</a> implementation. </p>
<p>This class manages background syncs for different profiles. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a87f8d43ef5d56eb52c8d486327b9dd07"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BackgroundSync::BackgroundSync </td>
<td>(</td>
<td class="paramtype">QObject * </td>
<td class="paramname"><em>aParent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aParent</td><td>Parent object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab6a2691e2bea24eaff41289255aa500d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BackgroundSync::onBackgroundSwitchRunning </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>aProfName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal will be emitted when a switch timer for particular profile is triggered. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile for which switch timer is triggered. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a492f9f7ba84e6a42799de847acc1815b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BackgroundSync::onBackgroundSyncCompleted </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>aProfName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when background sync is completed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile for which background sync is completed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adba0bbba28cdc4d5870d55e48edadfe1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void BackgroundSync::onBackgroundSyncRunning </td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>aProfName</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">signal</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This signal will be emitted when a background sync timer for particular profile is triggered. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile for which background sync timer is triggered. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af4f6f3a67195da140be8273b823edd13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BackgroundSync::remove </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>aProfName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes background sync for a profile. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad06d33838f34231621095e7e932c361e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BackgroundSync::removeSwitch </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>aProfName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a switch(rush/off-rush) for a profile. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac0d8a40e12763c2dbff0f44cde445391"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BackgroundSync::set </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>aProfName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>seconds</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules a background sync for this profile. </p>
<p>The beat will be generated between minWaitTime and maxWaitTime seconds </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile. </td></tr>
<tr><td class="paramname">seconds</td><td>Sync frequency in seconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Success indicator. </dd></dl>
</div>
</div>
<a class="anchor" id="ae293ec7bd6e44b0ffb3ade6476259f7c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BackgroundSync::setSwitch </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>aProfName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QDateTime & </td>
<td class="paramname"><em>aSwitchTime</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Schedules a switch(rush/off-rush) for a background sync running for this profile, the switch should be added after the background activity. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aProfName</td><td>Name of the profile. </td></tr>
<tr><td class="paramname">aSwitchTime</td><td>when the switch will occurs </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Success indicator. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="BackgroundSync_8h_source.html">BackgroundSync.h</a></li>
<li>BackgroundSync.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Dec 16 2015 19:19:26 for ButeoSynchronizationFramework by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|