Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_r_thread_client.html
changeset 1 25a17d01db0c
child 6 43e37759235e
equal deleted inserted replaced
0:89d6a7a84779 1:25a17d01db0c
       
     1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
       
     2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
       
     3 <title>TB10.1 Example Applications: RThreadClient Class Reference</title>
       
     4 <link href="doxygen.css" rel="stylesheet" type="text/css">
       
     5 <link href="tabs.css" rel="stylesheet" type="text/css">
       
     6 </head><body>
       
     7 <!-- Generated by Doxygen 1.5.3 -->
       
     8 <h1>RThreadClient Class Reference</h1><!-- doxytag: class="RThreadClient" -->
       
     9 <p>
       
    10 <a href="class_r_thread_client-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
       
    11 <tr><td></td></tr>
       
    12 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
       
    13 <tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#fc30d492698d70ffcf1699ed30be41af">Connect</a> ()</td></tr>
       
    14 
       
    15 <tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#08a81078c1757ec543c957a2bdc926c0">OpenDriver</a> ()</td></tr>
       
    16 
       
    17 <tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#236149601a88df1c7b80fd9259454528">Send</a> (const TDesC8 &amp;aBuf, TRequestStatus &amp;aStatus)</td></tr>
       
    18 
       
    19 <tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#177b9da53bb469b741c9b5bb1243b7ec">SendCancel</a> ()</td></tr>
       
    20 
       
    21 <tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#6d1378569255876c4a4e901328ad02b3">UnloadDeviceDriver</a> ()</td></tr>
       
    22 
       
    23 <tr><td class="memItemLeft" nowrap align="right" valign="top">IMPORT_C TInt&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_thread_client.html#52eb0c4b09e2f0a7b2f13e91902286b2">LoadDeviceDriver</a> ()</td></tr>
       
    24 
       
    25 </table>
       
    26 <hr><a name="_details"></a><h2>Detailed Description</h2>
       
    27 Client interface for thread server 
       
    28 <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>
       
    29 <hr><h2>Member Function Documentation</h2>
       
    30 <a class="anchor" name="fc30d492698d70ffcf1699ed30be41af"></a><!-- doxytag: member="RThreadClient::Connect" ref="fc30d492698d70ffcf1699ed30be41af" args="()" -->
       
    31 <div class="memitem">
       
    32 <div class="memproto">
       
    33       <table class="memname">
       
    34         <tr>
       
    35           <td class="memname">EXPORT_C TInt RThreadClient::Connect           </td>
       
    36           <td>(</td>
       
    37           <td class="paramname">          </td>
       
    38           <td>&nbsp;)&nbsp;</td>
       
    39           <td width="100%"></td>
       
    40         </tr>
       
    41       </table>
       
    42 </div>
       
    43 <div class="memdoc">
       
    44 
       
    45 <p>
       
    46 Connects to the server, attempting to start it if necessary<p>
       
    47 Connect to the server, attempting to start it if necessary 
       
    48 <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>
       
    49 
       
    50 </div>
       
    51 </div><p>
       
    52 <a class="anchor" name="08a81078c1757ec543c957a2bdc926c0"></a><!-- doxytag: member="RThreadClient::OpenDriver" ref="08a81078c1757ec543c957a2bdc926c0" args="()" -->
       
    53 <div class="memitem">
       
    54 <div class="memproto">
       
    55       <table class="memname">
       
    56         <tr>
       
    57           <td class="memname">EXPORT_C TInt RThreadClient::OpenDriver           </td>
       
    58           <td>(</td>
       
    59           <td class="paramname">          </td>
       
    60           <td>&nbsp;)&nbsp;</td>
       
    61           <td width="100%"></td>
       
    62         </tr>
       
    63       </table>
       
    64 </div>
       
    65 <div class="memdoc">
       
    66 
       
    67 <p>
       
    68 Opens the device driver's logical channel<p>
       
    69 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>
       
    70 
       
    71 <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>
       
    72 
       
    73 </div>
       
    74 </div><p>
       
    75 <a class="anchor" name="236149601a88df1c7b80fd9259454528"></a><!-- doxytag: member="RThreadClient::Send" ref="236149601a88df1c7b80fd9259454528" args="(const TDesC8 &amp;aBuf, TRequestStatus &amp;aStatus)" -->
       
    76 <div class="memitem">
       
    77 <div class="memproto">
       
    78       <table class="memname">
       
    79         <tr>
       
    80           <td class="memname">EXPORT_C void RThreadClient::Send           </td>
       
    81           <td>(</td>
       
    82           <td class="paramtype">const TDesC8 &amp;&nbsp;</td>
       
    83           <td class="paramname"> <em>aBuf</em>, </td>
       
    84         </tr>
       
    85         <tr>
       
    86           <td class="paramkey"></td>
       
    87           <td></td>
       
    88           <td class="paramtype">TRequestStatus &amp;&nbsp;</td>
       
    89           <td class="paramname"> <em>aStatus</em></td><td>&nbsp;</td>
       
    90         </tr>
       
    91         <tr>
       
    92           <td></td>
       
    93           <td>)</td>
       
    94           <td></td><td></td><td width="100%"></td>
       
    95         </tr>
       
    96       </table>
       
    97 </div>
       
    98 <div class="memdoc">
       
    99 
       
   100 <p>
       
   101 Sends data to device (asynchronous request)<p>
       
   102 Send data to device (asynchronous request) <dl compact><dt><b>Parameters:</b></dt><dd>
       
   103   <table border="0" cellspacing="2" cellpadding="0">
       
   104     <tr><td valign="top"></td><td valign="top"><em>aBuf</em>&nbsp;</td><td>A descriptor which contains the data to be sent </td></tr>
       
   105     <tr><td valign="top"></td><td valign="top"><em>aStatus</em>&nbsp;</td><td>A TRequestStatus reference </td></tr>
       
   106   </table>
       
   107 </dl>
       
   108 
       
   109 <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>
       
   110 
       
   111 </div>
       
   112 </div><p>
       
   113 <a class="anchor" name="177b9da53bb469b741c9b5bb1243b7ec"></a><!-- doxytag: member="RThreadClient::SendCancel" ref="177b9da53bb469b741c9b5bb1243b7ec" args="()" -->
       
   114 <div class="memitem">
       
   115 <div class="memproto">
       
   116       <table class="memname">
       
   117         <tr>
       
   118           <td class="memname">EXPORT_C void RThreadClient::SendCancel           </td>
       
   119           <td>(</td>
       
   120           <td class="paramname">          </td>
       
   121           <td>&nbsp;)&nbsp;</td>
       
   122           <td width="100%"></td>
       
   123         </tr>
       
   124       </table>
       
   125 </div>
       
   126 <div class="memdoc">
       
   127 
       
   128 <p>
       
   129 Cancels sending request<p>
       
   130 Cancel sending request 
       
   131 <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>
       
   132 
       
   133 </div>
       
   134 </div><p>
       
   135 <a class="anchor" name="6d1378569255876c4a4e901328ad02b3"></a><!-- doxytag: member="RThreadClient::UnloadDeviceDriver" ref="6d1378569255876c4a4e901328ad02b3" args="()" -->
       
   136 <div class="memitem">
       
   137 <div class="memproto">
       
   138       <table class="memname">
       
   139         <tr>
       
   140           <td class="memname">EXPORT_C TInt RThreadClient::UnloadDeviceDriver           </td>
       
   141           <td>(</td>
       
   142           <td class="paramname">          </td>
       
   143           <td>&nbsp;)&nbsp;</td>
       
   144           <td width="100%"></td>
       
   145         </tr>
       
   146       </table>
       
   147 </div>
       
   148 <div class="memdoc">
       
   149 
       
   150 <p>
       
   151 Unloads device driver<p>
       
   152 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>
       
   153 
       
   154 <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>
       
   155 
       
   156 </div>
       
   157 </div><p>
       
   158 <a class="anchor" name="52eb0c4b09e2f0a7b2f13e91902286b2"></a><!-- doxytag: member="RThreadClient::LoadDeviceDriver" ref="52eb0c4b09e2f0a7b2f13e91902286b2" args="()" -->
       
   159 <div class="memitem">
       
   160 <div class="memproto">
       
   161       <table class="memname">
       
   162         <tr>
       
   163           <td class="memname">EXPORT_C TInt RThreadClient::LoadDeviceDriver           </td>
       
   164           <td>(</td>
       
   165           <td class="paramname">          </td>
       
   166           <td>&nbsp;)&nbsp;</td>
       
   167           <td width="100%"></td>
       
   168         </tr>
       
   169       </table>
       
   170 </div>
       
   171 <div class="memdoc">
       
   172 
       
   173 <p>
       
   174 Loads device driver<p>
       
   175 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>
       
   176 
       
   177 <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>
       
   178 
       
   179 </div>
       
   180 </div><p>
       
   181 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by&nbsp;
       
   182 <a href="http://www.doxygen.org/index.html">
       
   183 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
       
   184 </body>
       
   185 </html>