Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_listener.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: CListener 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>CListener Class Reference</h1><!-- doxytag: class="CListener" -->
<p><a href="class_c_listener-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>TState</b> { <b>ENone</b> = 1,
<b>EConnecting</b>,
<b>EWaiting</b>,
<b>ESending</b>
}</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#a3b683a4704ee1582bf8a9832a19377a2">~CListener</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#a4e5f34e32cb42629abb254387b5d56d8">StartListenerL</a> (TInt &aChannel)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#a0e61bc07e3817ba26d45ea21f0e1b445">StopListener</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#a98d8907f2a44e7a885bea1d68bc2942d">SendData</a> (const TDesC8 &aData)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#acc9817ffb901295106d82ed665abff9c">IsConnected</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_listener.html">CListener</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#ad5bda32af6be0c04ab0550c2eef0f61a">NewL</a> (<a class="el" href="class_m_listener_observer.html">MListenerObserver</a> &aObserver, RSocketServ &aSocketServ)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_listener.html">CListener</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_listener.html#afa0b1916e829a728911a95aa41669200">NewLC</a> (<a class="el" href="class_m_listener_observer.html">MListenerObserver</a> &aObserver, RSocketServ &aSocketServ)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88ffc2c4ce9008e5055463278c09667e"></a><!-- doxytag: member="CListener::iListenSock" ref="a88ffc2c4ce9008e5055463278c09667e" args="" -->
RSocket </td><td class="memItemRight" valign="bottom"><b>iListenSock</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af287752a64f91cd4cb6041c9063d87ae"></a><!-- doxytag: member="CListener::iSock" ref="af287752a64f91cd4cb6041c9063d87ae" args="" -->
RSocket </td><td class="memItemRight" valign="bottom"><b>iSock</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6fd7f04e99f570a20cc6b2a8bb1353e4"></a><!-- doxytag: member="CListener::iLen" ref="a6fd7f04e99f570a20cc6b2a8bb1353e4" args="" -->
TSockXfrLength </td><td class="memItemRight" valign="bottom"><b>iLen</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeddae2cf4c7ab6309ef2d963c8ad8baf"></a><!-- doxytag: member="CListener::iBuffer" ref="aeddae2cf4c7ab6309ef2d963c8ad8baf" args="" -->
TBuf8< KReceivedBufferSize > </td><td class="memItemRight" valign="bottom"><b>iBuffer</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12e77859ba0b435ec00867e2018674f4"></a><!-- doxytag: member="CListener::iObserver" ref="a12e77859ba0b435ec00867e2018674f4" args="" -->
<a class="el" href="class_m_listener_observer.html">MListenerObserver</a> & </td><td class="memItemRight" valign="bottom"><b>iObserver</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15e928e0e954e243b052e72205a8f921"></a><!-- doxytag: member="CListener::iSocketServ" ref="a15e928e0e954e243b052e72205a8f921" args="" -->
RSocketServ & </td><td class="memItemRight" valign="bottom"><b>iSocketServ</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d71b0de3a3aad5a4a8c0a8a4661cb6d"></a><!-- doxytag: member="CListener::iIsConnected" ref="a8d71b0de3a3aad5a4a8c0a8a4661cb6d" args="" -->
TBool </td><td class="memItemRight" valign="bottom"><b>iIsConnected</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65b25ff887771b382622d44dd6ca0294"></a><!-- doxytag: member="CListener::iState" ref="a65b25ff887771b382622d44dd6ca0294" args="" -->
TState </td><td class="memItemRight" valign="bottom"><b>iState</b></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_listener.html#ac401ea21ad375cc6da0345fcb8fa1a62">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_listener.html#a23067cb6f486851b7faf94970d8980a2">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaeb940a914353e856aabc20b2b6ec3e8"></a><!-- doxytag: member="CListener::RunError" ref="aaeb940a914353e856aabc20b2b6ec3e8" args="(TInt aError)" -->
TInt </td><td class="memItemRight" valign="bottom"><b>RunError</b> (TInt aError)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_listener_8h_source.html#l00045">45</a> of file <a class="el" href="_listener_8h_source.html">Listener.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3b683a4704ee1582bf8a9832a19377a2"></a><!-- doxytag: member="CListener::~CListener" ref="a3b683a4704ee1582bf8a9832a19377a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CListener::~CListener </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>~CConnector()</p>
<p>discussion Destroy the object and release all memory objects </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00057">57</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad5bda32af6be0c04ab0550c2eef0f61a"></a><!-- doxytag: member="CListener::NewL" ref="ad5bda32af6be0c04ab0550c2eef0f61a" args="(MListenerObserver &aObserver, RSocketServ &aSocketServ)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_listener.html">CListener</a> * CListener::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_listener_observer.html">MListenerObserver</a> & </td>
<td class="paramname"> <em>aObserver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RSocketServ & </td>
<td class="paramname"> <em>aSocketServ</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><a class="el" href="class_c_listener.html#ad5bda32af6be0c04ab0550c2eef0f61a">NewL()</a></p>
<p>discussion Create new <a class="el" href="class_c_listener.html">CListener</a> object return a pointer to the created instance of <a class="el" href="class_c_listener.html">CListener</a> </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00010">10</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afa0b1916e829a728911a95aa41669200"></a><!-- doxytag: member="CListener::NewLC" ref="afa0b1916e829a728911a95aa41669200" args="(MListenerObserver &aObserver, RSocketServ &aSocketServ)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_listener.html">CListener</a> * CListener::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_listener_observer.html">MListenerObserver</a> & </td>
<td class="paramname"> <em>aObserver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">RSocketServ & </td>
<td class="paramname"> <em>aSocketServ</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><a class="el" href="class_c_listener.html#afa0b1916e829a728911a95aa41669200">NewLC()</a> </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00019">19</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4e5f34e32cb42629abb254387b5d56d8"></a><!-- doxytag: member="CListener::StartListenerL" ref="a4e5f34e32cb42629abb254387b5d56d8" args="(TInt &aChannel)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListener::StartListenerL </td>
<td>(</td>
<td class="paramtype">TInt & </td>
<td class="paramname"> <em>aChannel</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_listener.html#a4e5f34e32cb42629abb254387b5d56d8">StartListenerL()</a></p>
<p>discussion Starts the listener. listener will open a listening socket and listen on incoming connections.</p>
<p>param aChannel the communication channel (port) the listener listens to. </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00072">72</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0e61bc07e3817ba26d45ea21f0e1b445"></a><!-- doxytag: member="CListener::StopListener" ref="a0e61bc07e3817ba26d45ea21f0e1b445" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListener::StopListener </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_listener.html#a0e61bc07e3817ba26d45ea21f0e1b445">StopListener()</a></p>
<p>discussion Stops the listener, closes the listening socket. </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00181">181</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a98d8907f2a44e7a885bea1d68bc2942d"></a><!-- doxytag: member="CListener::SendData" ref="a98d8907f2a44e7a885bea1d68bc2942d" args="(const TDesC8 &aData)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListener::SendData </td>
<td>(</td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aData</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_listener.html#a98d8907f2a44e7a885bea1d68bc2942d">SendData()</a></p>
<p>discussion Sends data to master. user will be prompted to enter the message to send.</p>
<p>param aData the message to be send. </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00214">214</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acc9817ffb901295106d82ed665abff9c"></a><!-- doxytag: member="CListener::IsConnected" ref="acc9817ffb901295106d82ed665abff9c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CListener::IsConnected </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_listener.html#acc9817ffb901295106d82ed665abff9c">IsConnected()</a></p>
<p>discussion check if listener is connected to.</p>
<p>return true if listener has a connection from master. </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00304">304</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac401ea21ad375cc6da0345fcb8fa1a62"></a><!-- doxytag: member="CListener::RunL" ref="ac401ea21ad375cc6da0345fcb8fa1a62" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListener::RunL </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_listener.html#ac401ea21ad375cc6da0345fcb8fa1a62">RunL()</a></p>
<p>discussion Handle the active objects request completion. </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00230">230</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a23067cb6f486851b7faf94970d8980a2"></a><!-- doxytag: member="CListener::DoCancel" ref="a23067cb6f486851b7faf94970d8980a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CListener::DoCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_listener.html#a23067cb6f486851b7faf94970d8980a2">DoCancel()</a></p>
<p>discussion Cancels the outstanding request on active object. </p>
<p>Definition at line <a class="el" href="_listener_8cpp_source.html#l00291">291</a> of file <a class="el" href="_listener_8cpp_source.html">Listener.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>