Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_thread_client.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: RThreadClient 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>RThreadClient Class Reference</h1><!-- doxytag: class="RThreadClient" --><!-- doxytag: inherits="RSessionBase" -->
<p>Inherits RSessionBase.</p>
<p><a href="class_r_thread_client-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">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#afc30d492698d70ffcf1699ed30be41af">Connect</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#a08a81078c1757ec543c957a2bdc926c0">OpenDriver</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#a236149601a88df1c7b80fd9259454528">Send</a> (const TDesC8 &aBuf, TRequestStatus &aStatus)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#a177b9da53bb469b741c9b5bb1243b7ec">SendCancel</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#a6d1378569255876c4a4e901328ad02b3">UnloadDeviceDriver</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#a52eb0c4b09e2f0a7b2f13e91902286b2">LoadDeviceDriver</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Client interface for thread server </p>
<p>Definition at line <a class="el" href="threadclient_8h_source.html#l00025">25</a> of file <a class="el" href="threadclient_8h_source.html">threadclient.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afc30d492698d70ffcf1699ed30be41af"></a><!-- doxytag: member="RThreadClient::Connect" ref="afc30d492698d70ffcf1699ed30be41af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C TInt RThreadClient::Connect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Connects to the server, attempting to start it if necessary</p>
<p>Connect to the server, attempting to start it if necessary </p>
<p>Definition at line <a class="el" href="threadclient_8cpp_source.html#l00068">68</a> of file <a class="el" href="threadclient_8cpp_source.html">threadclient.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a08a81078c1757ec543c957a2bdc926c0"></a><!-- doxytag: member="RThreadClient::OpenDriver" ref="a08a81078c1757ec543c957a2bdc926c0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C TInt RThreadClient::OpenDriver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens the device driver's logical channel</p>
<p>Open the device driver's logical channel </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="threadclient_8cpp_source.html#l00106">106</a> of file <a class="el" href="threadclient_8cpp_source.html">threadclient.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a236149601a88df1c7b80fd9259454528"></a><!-- doxytag: member="RThreadClient::Send" ref="a236149601a88df1c7b80fd9259454528" args="(const TDesC8 &aBuf, TRequestStatus &aStatus)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void RThreadClient::Send </td>
<td>(</td>
<td class="paramtype">const TDesC8 & </td>
<td class="paramname"> <em>aBuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TRequestStatus & </td>
<td class="paramname"> <em>aStatus</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends data to device (asynchronous request)</p>
<p>Send data to device (asynchronous request) </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aBuf</em> </td><td>A descriptor which contains the data to be sent </td></tr>
<tr><td valign="top"></td><td valign="top"><em>aStatus</em> </td><td>A TRequestStatus reference </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="threadclient_8cpp_source.html#l00115">115</a> of file <a class="el" href="threadclient_8cpp_source.html">threadclient.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a177b9da53bb469b741c9b5bb1243b7ec"></a><!-- doxytag: member="RThreadClient::SendCancel" ref="a177b9da53bb469b741c9b5bb1243b7ec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C void RThreadClient::SendCancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancels sending request</p>
<p>Cancel sending request </p>
<p>Definition at line <a class="el" href="threadclient_8cpp_source.html#l00122">122</a> of file <a class="el" href="threadclient_8cpp_source.html">threadclient.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6d1378569255876c4a4e901328ad02b3"></a><!-- doxytag: member="RThreadClient::UnloadDeviceDriver" ref="a6d1378569255876c4a4e901328ad02b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C TInt RThreadClient::UnloadDeviceDriver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Unloads device driver</p>
<p>Unload Device Driver </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="threadclient_8cpp_source.html#l00130">130</a> of file <a class="el" href="threadclient_8cpp_source.html">threadclient.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a52eb0c4b09e2f0a7b2f13e91902286b2"></a><!-- doxytag: member="RThreadClient::LoadDeviceDriver" ref="a52eb0c4b09e2f0a7b2f13e91902286b2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EXPORT_C TInt RThreadClient::LoadDeviceDriver </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Loads device driver</p>
<p>Load Device Driver </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>KErrNone if successful, otherwise one of the other system wide error codes. </dd></dl>
<p>Definition at line <a class="el" href="threadclient_8cpp_source.html#l00138">138</a> of file <a class="el" href="threadclient_8cpp_source.html">threadclient.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>