Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_thread_client.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: RThreadClient Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<h1>RThreadClient Class Reference</h1><!-- doxytag: class="RThreadClient" -->
<p>
<a href="class_r_thread_client-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#fc30d492698d70ffcf1699ed30be41af">Connect</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#08a81078c1757ec543c957a2bdc926c0">OpenDriver</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#236149601a88df1c7b80fd9259454528">Send</a> (const TDesC8 &aBuf, TRequestStatus &aStatus)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#177b9da53bb469b741c9b5bb1243b7ec">SendCancel</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#6d1378569255876c4a4e901328ad02b3">UnloadDeviceDriver</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#52eb0c4b09e2f0a7b2f13e91902286b2">LoadDeviceDriver</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Client interface for thread server
<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" name="fc30d492698d70ffcf1699ed30be41af"></a><!-- doxytag: member="RThreadClient::Connect" ref="fc30d492698d70ffcf1699ed30be41af" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connects to the server, attempting to start it if necessary<p>
Connect to the server, attempting to start it if necessary
<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><p>
<a class="anchor" name="08a81078c1757ec543c957a2bdc926c0"></a><!-- doxytag: member="RThreadClient::OpenDriver" ref="08a81078c1757ec543c957a2bdc926c0" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opens the device driver's logical channel<p>
Open the device driver's logical channel <dl class="return" compact><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><p>
<a class="anchor" name="236149601a88df1c7b80fd9259454528"></a><!-- doxytag: member="RThreadClient::Send" ref="236149601a88df1c7b80fd9259454528" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends data to device (asynchronous request)<p>
Send data to device (asynchronous request) <dl compact><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>
</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><p>
<a class="anchor" name="177b9da53bb469b741c9b5bb1243b7ec"></a><!-- doxytag: member="RThreadClient::SendCancel" ref="177b9da53bb469b741c9b5bb1243b7ec" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cancels sending request<p>
Cancel sending request
<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><p>
<a class="anchor" name="6d1378569255876c4a4e901328ad02b3"></a><!-- doxytag: member="RThreadClient::UnloadDeviceDriver" ref="6d1378569255876c4a4e901328ad02b3" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unloads device driver<p>
Unload Device Driver <dl class="return" compact><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><p>
<a class="anchor" name="52eb0c4b09e2f0a7b2f13e91902286b2"></a><!-- doxytag: member="RThreadClient::LoadDeviceDriver" ref="52eb0c4b09e2f0a7b2f13e91902286b2" 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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads device driver<p>
Load Device Driver <dl class="return" compact><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><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>