Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_bluetooth_refresh_timer.html
changeset 6 43e37759235e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_bluetooth_refresh_timer.html	Tue Mar 30 16:16:55 2010 +0100
@@ -0,0 +1,247 @@
+<!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"/>
+<title>TB9.2 Example Applications: CBluetoothRefreshTimer Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
+<div class="contents">
+<h1>CBluetoothRefreshTimer Class Reference</h1><!-- doxytag: class="CBluetoothRefreshTimer" -->
+<p><a href="class_c_bluetooth_refresh_timer-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#afb7e5ebedb0475a393d24030ce4b91e4">~CBluetoothRefreshTimer</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a0198ef7e6c6f86cc29f32cbd0105e5d9">DoCancel</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a35ac4274326e25348a4c1536c6b13943">RunL</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a5dee58121e84aedaf3d21698add7216f">RunError</a> (TInt aError)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a8f2c8cdde49f04754b4ed693228da3e0">StartL</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a270c66a754cbb2acc85c2b87709192b0">StopWaitLoop</a> ()</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a8442cf6f32eb9cd6d10a0ca56fd8cada">SetRefreshTime</a> (TInt aRefreshTime)</td></tr>
+<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a122b128888ef9a86b0a4710c1459b3e2">NewL</a> (<a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> *aSMediator, CActiveSchedulerWait *aWait)</td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_bluetooth_refresh_timer.html#a10697495f27262ca4119892932cf5be3">NewLC</a> (<a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> *aSMediator, CActiveSchedulerWait *aWait)</td></tr>
+</table>
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> refreshes bluetooth device list. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8h_source.html#l00026">26</a> of file <a class="el" href="bluetoothrefreshtimer_8h_source.html">bluetoothrefreshtimer.h</a>.</p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="afb7e5ebedb0475a393d24030ce4b91e4"></a><!-- doxytag: member="CBluetoothRefreshTimer::~CBluetoothRefreshTimer" ref="afb7e5ebedb0475a393d24030ce4b91e4" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">CBluetoothRefreshTimer::~CBluetoothRefreshTimer </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>Destructor </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00038">38</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="a122b128888ef9a86b0a4710c1459b3e2"></a><!-- doxytag: member="CBluetoothRefreshTimer::NewL" ref="a122b128888ef9a86b0a4710c1459b3e2" args="(CSharedIntermediator *aSMediator, CActiveSchedulerWait *aWait)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> * CBluetoothRefreshTimer::NewL </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> *&nbsp;</td>
+          <td class="paramname"> <em>aSMediator</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CActiveSchedulerWait *&nbsp;</td>
+          <td class="paramname"> <em>aWait</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a122b128888ef9a86b0a4710c1459b3e2">NewL()</a></p>
+<p>discussion Create new <a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> object param aSMediator a shared intermediator. param aWait a scheduler loop owner. return a pointer to the created instance of <a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00045">45</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a10697495f27262ca4119892932cf5be3"></a><!-- doxytag: member="CBluetoothRefreshTimer::NewLC" ref="a10697495f27262ca4119892932cf5be3" args="(CSharedIntermediator *aSMediator, CActiveSchedulerWait *aWait)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> * CBluetoothRefreshTimer::NewLC </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> *&nbsp;</td>
+          <td class="paramname"> <em>aSMediator</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">CActiveSchedulerWait *&nbsp;</td>
+          <td class="paramname"> <em>aWait</em></td><td>&nbsp;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td><td><code> [static]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a10697495f27262ca4119892932cf5be3">NewLC()</a> </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00054">54</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a0198ef7e6c6f86cc29f32cbd0105e5d9"></a><!-- doxytag: member="CBluetoothRefreshTimer::DoCancel" ref="a0198ef7e6c6f86cc29f32cbd0105e5d9" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CBluetoothRefreshTimer::DoCancel </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p>DoCancelL()</p>
+<p>discussion Cancels the timer. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00137">137</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a35ac4274326e25348a4c1536c6b13943"></a><!-- doxytag: member="CBluetoothRefreshTimer::RunL" ref="a35ac4274326e25348a4c1536c6b13943" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CBluetoothRefreshTimer::RunL </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a35ac4274326e25348a4c1536c6b13943">RunL()</a></p>
+<p>discussion Implementation of the timer's virtual method. Check that all threads are alive and running, if not then restart them. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00101">101</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a5dee58121e84aedaf3d21698add7216f"></a><!-- doxytag: member="CBluetoothRefreshTimer::RunError" ref="a5dee58121e84aedaf3d21698add7216f" args="(TInt aError)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">TInt CBluetoothRefreshTimer::RunError </td>
+          <td>(</td>
+          <td class="paramtype">TInt&nbsp;</td>
+          <td class="paramname"> <em>aError</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a5dee58121e84aedaf3d21698add7216f">RunError()</a></p>
+<p>discussion Handles a leave occurring in the request completion event handler <a class="el" href="class_c_bluetooth_refresh_timer.html#a35ac4274326e25348a4c1536c6b13943">RunL()</a> return returns always KErrNone. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00163">163</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a8f2c8cdde49f04754b4ed693228da3e0"></a><!-- doxytag: member="CBluetoothRefreshTimer::StartL" ref="a8f2c8cdde49f04754b4ed693228da3e0" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CBluetoothRefreshTimer::StartL </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a8f2c8cdde49f04754b4ed693228da3e0">StartL()</a></p>
+<p>discussion Start searching for bluetooth devices. Activate refresh timer. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00077">77</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a270c66a754cbb2acc85c2b87709192b0"></a><!-- doxytag: member="CBluetoothRefreshTimer::StopWaitLoop" ref="a270c66a754cbb2acc85c2b87709192b0" args="()" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CBluetoothRefreshTimer::StopWaitLoop </td>
+          <td>(</td>
+          <td class="paramname"></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a270c66a754cbb2acc85c2b87709192b0">StopWaitLoop()</a></p>
+<p>discussion Stop active scheduler wait loop. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00090">90</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+<a class="anchor" id="a8442cf6f32eb9cd6d10a0ca56fd8cada"></a><!-- doxytag: member="CBluetoothRefreshTimer::SetRefreshTime" ref="a8442cf6f32eb9cd6d10a0ca56fd8cada" args="(TInt aRefreshTime)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void CBluetoothRefreshTimer::SetRefreshTime </td>
+          <td>(</td>
+          <td class="paramtype">TInt&nbsp;</td>
+          <td class="paramname"> <em>aRefreshTime</em></td>
+          <td>&nbsp;)&nbsp;</td>
+          <td></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+<p><a class="el" href="class_c_bluetooth_refresh_timer.html#a8442cf6f32eb9cd6d10a0ca56fd8cada">SetRefreshTime()</a></p>
+<p>discussion Set new refresh time. param aRefreshTime a new refresh time in seconds. </p>
+
+<p>Definition at line <a class="el" href="bluetoothrefreshtimer_8cpp_source.html#l00147">147</a> of file <a class="el" href="bluetoothrefreshtimer_8cpp_source.html">bluetoothrefreshtimer.cpp</a>.</p>
+
+</div>
+</div>
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
+</body>
+</html>