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