Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_time_out_timer.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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: CTimeOutTimer 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>CTimeOutTimer Class Reference</h1><!-- doxytag: class="CTimeOutTimer" -->
<p><a href="class_c_time_out_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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_out_timer.html#a11e245461c6f57e238aa0c991824c3fc">~CTimeOutTimer</a> ()</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_time_out_timer.html">CTimeOutTimer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_out_timer.html#a4cc1f595fc6c8b99ccaef6eb42cdcd7a">NewL</a> (const TInt aPriority, <a class="el" href="class_m_timeout_notifier.html">MTimeoutNotifier</a> &aNotify)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_time_out_timer.html">CTimeOutTimer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_out_timer.html#aaf0958f9d02f3060f49d234e31d9bcee">NewLC</a> (const TInt aPriority, <a class="el" href="class_m_timeout_notifier.html">MTimeoutNotifier</a> &aNotify)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72113cd4357291cd765172d7284a7478"></a><!-- doxytag: member="CTimeOutTimer::NewL" ref="a72113cd4357291cd765172d7284a7478" args="(const TInt aPriority, MTimeOutNotify &aTimeOutNotify)" -->
static <a class="el" href="class_c_time_out_timer.html">CTimeOutTimer</a> * </td><td class="memItemRight" valign="bottom"><b>NewL</b> (const TInt aPriority, <a class="el" href="class_m_time_out_notify.html">MTimeOutNotify</a> &aTimeOutNotify)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_out_timer.html#aef6eda1dd050a1b73a56849e3bba9897">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_out_timer.html#ab574c44ee156cc40022bb9bdfe6557d5">RunError</a> (TInt aError)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd1cc8080df81941fbe816441249518a"></a><!-- doxytag: member="CTimeOutTimer::CTimeOutTimer" ref="abd1cc8080df81941fbe816441249518a" args="(const TInt aPriority)" -->
</td><td class="memItemRight" valign="bottom"><b>CTimeOutTimer</b> (const TInt aPriority)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_time_out_timer.html#ab1966a9b992a0311812ae8f7c23eba0b">ConstructL</a> (<a class="el" href="class_m_time_out_notify.html">MTimeOutNotify</a> &aTimeOutNotify)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa85bc65f91ae6afecfb055684bbcd15d"></a><!-- doxytag: member="CTimeOutTimer::RunL" ref="aa85bc65f91ae6afecfb055684bbcd15d" args="()" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>RunL</b> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class that raises timeout events. </p>
<p>Definition at line <a class="el" href="_time_out_timer_8h_source.html#l00035">35</a> of file <a class="el" href="_time_out_timer_8h_source.html">TimeOutTimer.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a11e245461c6f57e238aa0c991824c3fc"></a><!-- doxytag: member="CTimeOutTimer::~CTimeOutTimer" ref="a11e245461c6f57e238aa0c991824c3fc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CTimeOutTimer::~CTimeOutTimer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor </p>
<p>Definition at line <a class="el" href="_time_out_timer_8cpp_source.html#l00025">25</a> of file <a class="el" href="_time_out_timer_8cpp_source.html">TimeOutTimer.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4cc1f595fc6c8b99ccaef6eb42cdcd7a"></a><!-- doxytag: member="CTimeOutTimer::NewL" ref="a4cc1f595fc6c8b99ccaef6eb42cdcd7a" args="(const TInt aPriority, MTimeoutNotifier &aNotify)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_time_out_timer.html">CTimeOutTimer</a> * CTimeOutTimer::NewL </td>
<td>(</td>
<td class="paramtype">const TInt </td>
<td class="paramname"> <em>aPriority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_m_timeout_notifier.html">MTimeoutNotifier</a> & </td>
<td class="paramname"> <em>aNotify</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Standard Symbian two-phase construction </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aPriority</em> </td><td>Priority of the active object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aNotify</em> </td><td>Timer observer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_time_out_timer_8cpp_source.html#l00045">45</a> of file <a class="el" href="_time_out_timer_8cpp_source.html">TimeOutTimer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaf0958f9d02f3060f49d234e31d9bcee"></a><!-- doxytag: member="CTimeOutTimer::NewLC" ref="aaf0958f9d02f3060f49d234e31d9bcee" args="(const TInt aPriority, MTimeoutNotifier &aNotify)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_time_out_timer.html">CTimeOutTimer</a> * CTimeOutTimer::NewLC </td>
<td>(</td>
<td class="paramtype">const TInt </td>
<td class="paramname"> <em>aPriority</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_m_timeout_notifier.html">MTimeoutNotifier</a> & </td>
<td class="paramname"> <em>aNotify</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Standard Symbian two-phase construction </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aPriority</em> </td><td>Priority of the active object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aNotify</em> </td><td>A handle to the class to be notified of a timeout event. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_time_out_timer_8cpp_source.html#l00058">58</a> of file <a class="el" href="_time_out_timer_8cpp_source.html">TimeOutTimer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aef6eda1dd050a1b73a56849e3bba9897"></a><!-- doxytag: member="CTimeOutTimer::RunL" ref="aef6eda1dd050a1b73a56849e3bba9897" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimeOutTimer::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Active object post-request handling.</p>
<p>Timer request has completed, so notify the timer's owner </p>
<p>Definition at line <a class="el" href="_time_out_timer_8cpp_source.html#l00072">72</a> of file <a class="el" href="_time_out_timer_8cpp_source.html">TimeOutTimer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab574c44ee156cc40022bb9bdfe6557d5"></a><!-- doxytag: member="CTimeOutTimer::RunError" ref="ab574c44ee156cc40022bb9bdfe6557d5" args="(TInt aError)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CTimeOutTimer::RunError </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aError</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Handles a leave occurring in the request completion event handler <a class="el" href="class_c_time_out_timer.html#aef6eda1dd050a1b73a56849e3bba9897">RunL()</a> </p>
<p>Definition at line <a class="el" href="_time_out_timer_8cpp_source.html#l00084">84</a> of file <a class="el" href="_time_out_timer_8cpp_source.html">TimeOutTimer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab1966a9b992a0311812ae8f7c23eba0b"></a><!-- doxytag: member="CTimeOutTimer::ConstructL" ref="ab1966a9b992a0311812ae8f7c23eba0b" args="(MTimeOutNotify &aTimeOutNotify)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CTimeOutTimer::ConstructL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_time_out_notify.html">MTimeOutNotify</a> & </td>
<td class="paramname"> <em>aTimeOutNotify</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>ConstructL function is used to add the active object to the scheduler </p>
<p>Definition at line <a class="el" href="_e_c_h_o_e_n_g_8_c_p_p_source.html#l00459">459</a> of file <a class="el" href="_e_c_h_o_e_n_g_8_c_p_p_source.html">ECHOENG.CPP</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>