Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_connector.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: CConnector 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>CConnector Class Reference</h1><!-- doxytag: class="CConnector" -->
<p><a href="class_c_connector-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_connector.html#a182734207e03cf9b72a56fc417908a1d">~CConnector</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TRequestStatus </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_connector.html#a3c5da0fe4f3d9a04528d9f6f5a19755b">ConnectL</a> (THostName aName, TBTDevAddr aAddr, TInt aPort)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_connector.html#aa7bef8230682e64f354bec585426fdb5">Disconnect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_connector.html#a2eecddc3d4f5ff157d17820c0add199b">SendData</a> (const TDesC8 &)</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_connector.html">CConnector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_connector.html#a0dc0760eb3b611c82f28b184f49d6bd7">NewL</a> (<a class="el" href="class_m_connector_observer.html">MConnectorObserver</a> &aObserver, RSocketServ &aSocketServ)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_connector.html">CConnector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_connector.html#acf4a1927ce9786c1b8010b9cae1d5688">NewLC</a> (<a class="el" href="class_m_connector_observer.html">MConnectorObserver</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="a79b2adb8a4e079f65bd06fcffbad053f"></a><!-- doxytag: member="CConnector::iName" ref="a79b2adb8a4e079f65bd06fcffbad053f" args="" -->
THostName </td><td class="memItemRight" valign="bottom"><b>iName</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06770de056fb63abacd80718f0749b68"></a><!-- doxytag: member="CConnector::iAddr" ref="a06770de056fb63abacd80718f0749b68" args="" -->
TBTDevAddr </td><td class="memItemRight" valign="bottom"><b>iAddr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84cfa4462df8ae0cacc41acce7f9e30d"></a><!-- doxytag: member="CConnector::iPort" ref="a84cfa4462df8ae0cacc41acce7f9e30d" args="" -->
TInt </td><td class="memItemRight" valign="bottom"><b>iPort</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e6722ccab459028d68d6d1d351ebdda"></a><!-- doxytag: member="CConnector::iSock" ref="a5e6722ccab459028d68d6d1d351ebdda" 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="a45f11861e72988431f79861099f6a0ea"></a><!-- doxytag: member="CConnector::iBuffer" ref="a45f11861e72988431f79861099f6a0ea" args="" -->
TBuf8< 40 > </td><td class="memItemRight" valign="bottom"><b>iBuffer</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab568cf439880e37dda7af9d99740fcf1"></a><!-- doxytag: member="CConnector::iLen" ref="ab568cf439880e37dda7af9d99740fcf1" 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="a904232d4f7d535efc9f51aaf49fb6ff6"></a><!-- doxytag: member="CConnector::iObserver" ref="a904232d4f7d535efc9f51aaf49fb6ff6" args="" -->
<a class="el" href="class_m_connector_observer.html">MConnectorObserver</a> & </td><td class="memItemRight" valign="bottom"><b>iObserver</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58e4e7de3eb5639beabb1cb0256c4408"></a><!-- doxytag: member="CConnector::iSocketServ" ref="a58e4e7de3eb5639beabb1cb0256c4408" 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="a8936921d78d2fa6e469048e5d770002d"></a><!-- doxytag: member="CConnector::iState" ref="a8936921d78d2fa6e469048e5d770002d" 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_connector.html#ad8e86b9b23abc394fc0451a3ea82c81a">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_connector.html#ad00a6a26fea8373614265186057cf042">DoCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58ebd41266e0ba1bcc2054e782eb2219"></a><!-- doxytag: member="CConnector::RunError" ref="a58ebd41266e0ba1bcc2054e782eb2219" 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="_connector_8h_source.html#l00030">30</a> of file <a class="el" href="_connector_8h_source.html">Connector.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a182734207e03cf9b72a56fc417908a1d"></a><!-- doxytag: member="CConnector::~CConnector" ref="a182734207e03cf9b72a56fc417908a1d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CConnector::~CConnector </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_connector.html#a182734207e03cf9b72a56fc417908a1d">~CConnector()</a></p>
<p>discussion Destroy the object and release all memory objects </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00046">46</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0dc0760eb3b611c82f28b184f49d6bd7"></a><!-- doxytag: member="CConnector::NewL" ref="a0dc0760eb3b611c82f28b184f49d6bd7" args="(MConnectorObserver &aObserver, RSocketServ &aSocketServ)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_connector.html">CConnector</a> * CConnector::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_connector_observer.html">MConnectorObserver</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_connector.html#a0dc0760eb3b611c82f28b184f49d6bd7">NewL()</a></p>
<p>discussion Create new <a class="el" href="class_c_connector.html">CConnector</a> object return a pointer to the created instance of <a class="el" href="class_c_connector.html">CConnector</a> </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00011">11</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acf4a1927ce9786c1b8010b9cae1d5688"></a><!-- doxytag: member="CConnector::NewLC" ref="acf4a1927ce9786c1b8010b9cae1d5688" args="(MConnectorObserver &aObserver, RSocketServ &aSocketServ)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_connector.html">CConnector</a> * CConnector::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_m_connector_observer.html">MConnectorObserver</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_connector.html#acf4a1927ce9786c1b8010b9cae1d5688">NewLC()</a> </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00020">20</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3c5da0fe4f3d9a04528d9f6f5a19755b"></a><!-- doxytag: member="CConnector::ConnectL" ref="a3c5da0fe4f3d9a04528d9f6f5a19755b" args="(THostName aName, TBTDevAddr aAddr, TInt aPort)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TRequestStatus CConnector::ConnectL </td>
<td>(</td>
<td class="paramtype">THostName </td>
<td class="paramname"> <em>aName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TBTDevAddr </td>
<td class="paramname"> <em>aAddr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aPort</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_connector.html#a3c5da0fe4f3d9a04528d9f6f5a19755b">ConnectL()</a></p>
<p>discussion Creates a connection to given remote address on given port.</p>
<p>param aName the name of the slave to connect to. param aAddr the address of the slave to connect to. param aPort the port on slave to connect to.</p>
<p>return the status of connection attempt </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00065">65</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa7bef8230682e64f354bec585426fdb5"></a><!-- doxytag: member="CConnector::Disconnect" ref="aa7bef8230682e64f354bec585426fdb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CConnector::Disconnect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_connector.html#aa7bef8230682e64f354bec585426fdb5">Disconnect()</a></p>
<p>discussion Disconnects connector from slave. </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00104">104</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2eecddc3d4f5ff157d17820c0add199b"></a><!-- doxytag: member="CConnector::SendData" ref="a2eecddc3d4f5ff157d17820c0add199b" args="(const TDesC8 &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CConnector::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>SendDataL()</p>
<p>discussion Sends given data to slave.</p>
<p>param aData the message to send to slave. </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00123">123</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad8e86b9b23abc394fc0451a3ea82c81a"></a><!-- doxytag: member="CConnector::RunL" ref="ad8e86b9b23abc394fc0451a3ea82c81a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CConnector::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_connector.html#ad8e86b9b23abc394fc0451a3ea82c81a">RunL()</a></p>
<p>discussion Handle the active objects request completion. </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00152">152</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad00a6a26fea8373614265186057cf042"></a><!-- doxytag: member="CConnector::DoCancel" ref="ad00a6a26fea8373614265186057cf042" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CConnector::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_connector.html#ad00a6a26fea8373614265186057cf042">DoCancel()</a></p>
<p>discussion Cancels the outstanding request on active object. </p>
<p>Definition at line <a class="el" href="_connector_8cpp_source.html#l00054">54</a> of file <a class="el" href="_connector_8cpp_source.html">Connector.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>