Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_c_s_async_request_handler.html
Initial contribution of the Adaptation Documentation.
<!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: CCSAsyncRequestHandler 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>CCSAsyncRequestHandler Class Reference</h1><!-- doxytag: class="CCSAsyncRequestHandler" -->
<p><a href="class_c_c_s_async_request_handler-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_c_s_async_request_handler.html#abdff5aea2c8550c9399f2f78d8216e81">~CCSAsyncRequestHandler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_request_handler.html#ad34e374499b67c21347c5f87f7911324">RequestTime</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_request_handler.html#a64c5f14d32e4351b484cbc5717457d4c">CancelRequest</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TTime </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_request_handler.html#aabca1fcdd326961717cd467071b93432">Time</a> () const </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_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_request_handler.html#ace1ec40e7106ef002104b42eee746f64">NewL</a> (<a class="el" href="class_m_async_time_observer.html">MAsyncTimeObserver</a> &aObserver)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_request_handler.html#a5e2a6f65b5d2a9c33a1bae7d76c334d1">NewLC</a> (<a class="el" href="class_m_async_time_observer.html">MAsyncTimeObserver</a> &aObserver)</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_c_s_async_request_handler.html#a68039f23cd042511b6911beeec532a0f">RunL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_c_s_async_request_handler.html#ab2c9e682b7fc6a09691feeb8c8ffe721">DoCancel</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> An instance of the request handler object for the ClientServerAsync example application </p>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8h_source.html#l00033">33</a> of file <a class="el" href="csasyncrequesthandler_8h_source.html">csasyncrequesthandler.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="abdff5aea2c8550c9399f2f78d8216e81"></a><!-- doxytag: member="CCSAsyncRequestHandler::~CCSAsyncRequestHandler" ref="abdff5aea2c8550c9399f2f78d8216e81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CCSAsyncRequestHandler::~CCSAsyncRequestHandler </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CCSAsyncRequestHandler. Destructor. Destroys the object and release all memory objects. </p>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00077">77</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ace1ec40e7106ef002104b42eee746f64"></a><!-- doxytag: member="CCSAsyncRequestHandler::NewL" ref="ace1ec40e7106ef002104b42eee746f64" args="(MAsyncTimeObserver &aObserver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> * CCSAsyncRequestHandler::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_async_time_observer.html">MAsyncTimeObserver</a> & </td>
<td class="paramname"> <em>aObserver</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewL. Two-phased constructor. Creates a <a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> object using two phase construction, and return a pointer to the created object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aObserver</em> </td><td>The object to be used to handle updates from the server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the created instance of <a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a>. </dd></dl>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00030">30</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5e2a6f65b5d2a9c33a1bae7d76c334d1"></a><!-- doxytag: member="CCSAsyncRequestHandler::NewLC" ref="a5e2a6f65b5d2a9c33a1bae7d76c334d1" args="(MAsyncTimeObserver &aObserver)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> * CCSAsyncRequestHandler::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_async_time_observer.html">MAsyncTimeObserver</a> & </td>
<td class="paramname"> <em>aObserver</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>NewLC. Two-phased constructor. Creates a <a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a> object using two phase construction, and return a pointer to the created object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aObserver</em> </td><td>The object to be used to handle updates from the server. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the created instance of <a class="el" href="class_c_c_s_async_request_handler.html">CCSAsyncRequestHandler</a>. </dd></dl>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00042">42</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad34e374499b67c21347c5f87f7911324"></a><!-- doxytag: member="CCSAsyncRequestHandler::RequestTime" ref="ad34e374499b67c21347c5f87f7911324" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"></td >< td > The TRequestStatus object to be used <a class="el" href="interfacefor.html">for</a> async comms</td ></tr ></table ></dl >< p > Definition at line< a class="el"href="timeserversession_8cpp-source.html#l00075"></a > of file< a class="el"href="timeserversession_8cpp-source.html"> timeserversession cpp</a >< p > References< a class="el"href="timeserversession_8h-source.html#l00088"> iTimeBuffer</a >< p > Referenced by< a class="el"href="csasyncrequesthandler_8cpp-source.html#l00088"> CCSAsyncRequestHandler::RequestTime </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment"><span class="stringliteral">"el"</span> href=<span class="stringliteral">"csasyncappui_8cpp-source.html#l00084"</span>><a class="code" href="class_c_c_s_async_app_ui.html#ae2fec6b63cee85fe723168a3e949d9c1">CCSAsyncAppUi::HandleCommandL</a>()</a>.<div <span class="keyword">class</span>=<span class="stringliteral">"fragment"</span>><pre <span class="keyword">class</span>=<span class="stringliteral">"fragment"</span>><a name=<span class="stringliteral">"l00099"</span>></a>00099 {
<a name=<span class="stringliteral">"l00100"</span>></a>00100 <a <span class="keyword">class</span>=<span class="stringliteral">"code"</span> href=<span class="stringliteral">"class_c_c_s_async_document.html#56132cb68e64726ad0658571e44e9644"</span>>iHandler</a>-&gt;<a <span class="keyword">class</span>=<span class="stringliteral">"code"</span> href=<span class="stringliteral">"class_c_c_s_async_request_handler.html#481d63e2f4e33b9cb8ed4680a965da25"</span>><a class="code" href="class_c_c_s_async_request_handler.html#ad34e374499b67c21347c5f87f7911324">RequestTime</a></a>();
<a name=<span class="stringliteral">"l00101"</span>></a>00101 }
</pre></div>
<p>
</td>
</tr>
</table>
<a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"0dcbea3e9ce301f1d5ac23a7679b8ee0"</span>></a><!-- doxytag: member=<span class="stringliteral">"CCSAsyncDocument::StopClock"</span> ref=<span class="stringliteral">"0dcbea3e9ce301f1d5ac23a7679b8ee0"</span> args=<span class="stringliteral">"()"</span> --><p>
<table <span class="keyword">class</span>=<span class="stringliteral">"mdTable"</span> cellpadding=<span class="stringliteral">"2"</span> cellspacing=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdRow"</span>>
<table cellpadding=<span class="stringliteral">"0"</span> cellspacing=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> nowrap valign=<span class="stringliteral">"top"</span>><span class="keywordtype">void</span> <a class="code" href="class_c_c_s_async_document.html#add1f562e2b18c7318d3cf4c6c0abf8db">CCSAsyncDocument::StopClock</a> </td>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>(&nbsp;</td>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdname1"</span> valign=<span class="stringliteral">"top"</span> nowrap> </td>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> valign=<span class="stringliteral">"top"</span>>&nbsp;)&nbsp
</pre></div><p>RequestTime. Sends a request to the server for an update to the time. </p>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00088">88</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a64c5f14d32e4351b484cbc5717457d4c"></a><!-- doxytag: member="CCSAsyncRequestHandler::CancelRequest" ref="a64c5f14d32e4351b484cbc5717457d4c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"></td >< td >< p > StopClock Stops the clock< p > Definition at line< a class="el"href="csasyncdocument_8cpp-source.html#l00108"></a > of file< a class="el"href="csasyncdocument_8cpp-source.html"> csasyncdocument cpp</a >< p > References< a class="el"href="csasyncrequesthandler_8cpp-source.html#l00102"> CCSAsyncRequestHandler::CancelRequest </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>CancelRequest. Cancels an outstanding request. </p>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00102">102</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aabca1fcdd326961717cd467071b93432"></a><!-- doxytag: member="CCSAsyncRequestHandler::Time" ref="aabca1fcdd326961717cd467071b93432" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TTime CCSAsyncRequestHandler::Time </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Time. Gets a copy of the last time received from the server. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The time. </dd></dl>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00151">151</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a68039f23cd042511b6911beeec532a0f"></a><!-- doxytag: member="CCSAsyncRequestHandler::RunL" ref="a68039f23cd042511b6911beeec532a0f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CCSAsyncRequestHandler::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>From CActive, RunL. Callback function. Invoked to handle responses from the server. </p>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00112">112</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab2c9e682b7fc6a09691feeb8c8ffe721"></a><!-- doxytag: member="CCSAsyncRequestHandler::DoCancel" ref="ab2c9e682b7fc6a09691feeb8c8ffe721" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"></td >< td >< p > CancelRequestTime Cancels any outstanding request to the server< p > Definition at line< a class="el"href="timeserversession_8cpp-source.html#l00094"></a > of file< a class="el"href="timeserversession_8cpp-source.html"> timeserversession cpp</a >< p > Referenced by< a class="el"href="csasyncrequesthandler_8cpp-source.html#l00141"> CCSAsyncRequestHandler::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment"><span class="stringliteral">"fragment"</span>><pre <span class="keyword">class</span>=<span class="stringliteral">"fragment"</span>><a name=<span class="stringliteral">"l00095"</span>></a>00095 {
<a name=<span class="stringliteral">"l00096"</span>></a>00096 SendReceive( ETimeServCancelRequestTime, TIpcArgs(NULL) );
<a name=<span class="stringliteral">"l00097"</span>></a>00097 }
</pre></div>
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a <span class="keyword">class</span>=<span class="stringliteral">"anchor"</span> name=<span class="stringliteral">"828f90acd9ecd7a6283a9226001e3921"</span>></a><!-- doxytag: member=<span class="stringliteral">"RTimeServerSession::iTimeBuffer"</span> ref=<span class="stringliteral">"828f90acd9ecd7a6283a9226001e3921"</span> args=<span class="stringliteral">""</span> --><p>
<table <span class="keyword">class</span>=<span class="stringliteral">"mdTable"</span> cellpadding=<span class="stringliteral">"2"</span> cellspacing=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"mdRow"</span>>
<table cellpadding=<span class="stringliteral">"0"</span> cellspacing=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<tr>
<td <span class="keyword">class</span>=<span class="stringliteral">"md"</span> nowrap valign=<span class="stringliteral">"top"</span>>TPtr8 <a <span class="keyword">class</span>=<span class="stringliteral">"el"</span> href=<span class="stringliteral">"class_r_time_server_session.html#828f90acd9ecd7a6283a9226001e3921"</span>>RTimeServerSession::iTimeBuffer</a><code> [<span class="keyword">private</span>]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=<span class="stringliteral">"5"</span> cellpadding=<span class="stringliteral">"0"</span> border=<span class="stringliteral">"0"</span>>
<tr>
<td>
&nbsp
</pre></div><p>From CActive, DoCancel. Cancels any outstanding operation. </p>
<p>Definition at line <a class="el" href="csasyncrequesthandler_8cpp_source.html#l00141">141</a> of file <a class="el" href="csasyncrequesthandler_8cpp_source.html">csasyncrequesthandler.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>