|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html xmlns="http://www.w3.org/1999/xhtml"> |
|
3 <head> |
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
|
5 <title>TB9.2 Example Applications: CConnector Class Reference</title> |
|
6 <link href="tabs.css" rel="stylesheet" type="text/css"/> |
|
7 <link href="doxygen.css" rel="stylesheet" type="text/css"/> |
|
8 </head> |
|
9 <body> |
|
10 <!-- Generated by Doxygen 1.6.2 --> |
|
11 <div class="contents"> |
|
12 <h1>CConnector Class Reference</h1><!-- doxytag: class="CConnector" --> |
|
13 <p><a href="class_c_connector-members.html">List of all members.</a></p> |
|
14 <table border="0" cellpadding="0" cellspacing="0"> |
|
15 <tr><td colspan="2"><h2>Public Types</h2></td></tr> |
|
16 <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>TState</b> { <b>ENone</b> = 1, |
|
17 <b>EConnecting</b>, |
|
18 <b>EWaiting</b>, |
|
19 <b>ESending</b> |
|
20 }</td></tr> |
|
21 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> |
|
22 <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> |
|
23 <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> |
|
24 <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> |
|
25 <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> |
|
26 <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> |
|
27 <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> |
|
28 <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> |
|
29 <tr><td colspan="2"><h2>Public Attributes</h2></td></tr> |
|
30 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79b2adb8a4e079f65bd06fcffbad053f"></a><!-- doxytag: member="CConnector::iName" ref="a79b2adb8a4e079f65bd06fcffbad053f" args="" --> |
|
31 THostName </td><td class="memItemRight" valign="bottom"><b>iName</b></td></tr> |
|
32 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06770de056fb63abacd80718f0749b68"></a><!-- doxytag: member="CConnector::iAddr" ref="a06770de056fb63abacd80718f0749b68" args="" --> |
|
33 TBTDevAddr </td><td class="memItemRight" valign="bottom"><b>iAddr</b></td></tr> |
|
34 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84cfa4462df8ae0cacc41acce7f9e30d"></a><!-- doxytag: member="CConnector::iPort" ref="a84cfa4462df8ae0cacc41acce7f9e30d" args="" --> |
|
35 TInt </td><td class="memItemRight" valign="bottom"><b>iPort</b></td></tr> |
|
36 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e6722ccab459028d68d6d1d351ebdda"></a><!-- doxytag: member="CConnector::iSock" ref="a5e6722ccab459028d68d6d1d351ebdda" args="" --> |
|
37 RSocket </td><td class="memItemRight" valign="bottom"><b>iSock</b></td></tr> |
|
38 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a45f11861e72988431f79861099f6a0ea"></a><!-- doxytag: member="CConnector::iBuffer" ref="a45f11861e72988431f79861099f6a0ea" args="" --> |
|
39 TBuf8< 40 > </td><td class="memItemRight" valign="bottom"><b>iBuffer</b></td></tr> |
|
40 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab568cf439880e37dda7af9d99740fcf1"></a><!-- doxytag: member="CConnector::iLen" ref="ab568cf439880e37dda7af9d99740fcf1" args="" --> |
|
41 TSockXfrLength </td><td class="memItemRight" valign="bottom"><b>iLen</b></td></tr> |
|
42 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a904232d4f7d535efc9f51aaf49fb6ff6"></a><!-- doxytag: member="CConnector::iObserver" ref="a904232d4f7d535efc9f51aaf49fb6ff6" args="" --> |
|
43 <a class="el" href="class_m_connector_observer.html">MConnectorObserver</a> & </td><td class="memItemRight" valign="bottom"><b>iObserver</b></td></tr> |
|
44 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58e4e7de3eb5639beabb1cb0256c4408"></a><!-- doxytag: member="CConnector::iSocketServ" ref="a58e4e7de3eb5639beabb1cb0256c4408" args="" --> |
|
45 RSocketServ & </td><td class="memItemRight" valign="bottom"><b>iSocketServ</b></td></tr> |
|
46 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8936921d78d2fa6e469048e5d770002d"></a><!-- doxytag: member="CConnector::iState" ref="a8936921d78d2fa6e469048e5d770002d" args="" --> |
|
47 TState </td><td class="memItemRight" valign="bottom"><b>iState</b></td></tr> |
|
48 <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> |
|
49 <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> |
|
50 <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> |
|
51 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58ebd41266e0ba1bcc2054e782eb2219"></a><!-- doxytag: member="CConnector::RunError" ref="a58ebd41266e0ba1bcc2054e782eb2219" args="(TInt aError)" --> |
|
52 TInt </td><td class="memItemRight" valign="bottom"><b>RunError</b> (TInt aError)</td></tr> |
|
53 </table> |
|
54 <hr/><a name="_details"></a><h2>Detailed Description</h2> |
|
55 |
|
56 <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> |
|
57 <hr/><h2>Constructor & Destructor Documentation</h2> |
|
58 <a class="anchor" id="a182734207e03cf9b72a56fc417908a1d"></a><!-- doxytag: member="CConnector::~CConnector" ref="a182734207e03cf9b72a56fc417908a1d" args="()" --> |
|
59 <div class="memitem"> |
|
60 <div class="memproto"> |
|
61 <table class="memname"> |
|
62 <tr> |
|
63 <td class="memname">CConnector::~CConnector </td> |
|
64 <td>(</td> |
|
65 <td class="paramname"></td> |
|
66 <td> ) </td> |
|
67 <td></td> |
|
68 </tr> |
|
69 </table> |
|
70 </div> |
|
71 <div class="memdoc"> |
|
72 <p><a class="el" href="class_c_connector.html#a182734207e03cf9b72a56fc417908a1d">~CConnector()</a></p> |
|
73 <p>discussion Destroy the object and release all memory objects </p> |
|
74 |
|
75 <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> |
|
76 |
|
77 </div> |
|
78 </div> |
|
79 <hr/><h2>Member Function Documentation</h2> |
|
80 <a class="anchor" id="a0dc0760eb3b611c82f28b184f49d6bd7"></a><!-- doxytag: member="CConnector::NewL" ref="a0dc0760eb3b611c82f28b184f49d6bd7" args="(MConnectorObserver &aObserver, RSocketServ &aSocketServ)" --> |
|
81 <div class="memitem"> |
|
82 <div class="memproto"> |
|
83 <table class="memname"> |
|
84 <tr> |
|
85 <td class="memname"><a class="el" href="class_c_connector.html">CConnector</a> * CConnector::NewL </td> |
|
86 <td>(</td> |
|
87 <td class="paramtype"><a class="el" href="class_m_connector_observer.html">MConnectorObserver</a> & </td> |
|
88 <td class="paramname"> <em>aObserver</em>, </td> |
|
89 </tr> |
|
90 <tr> |
|
91 <td class="paramkey"></td> |
|
92 <td></td> |
|
93 <td class="paramtype">RSocketServ & </td> |
|
94 <td class="paramname"> <em>aSocketServ</em></td><td> </td> |
|
95 </tr> |
|
96 <tr> |
|
97 <td></td> |
|
98 <td>)</td> |
|
99 <td></td><td></td><td><code> [static]</code></td> |
|
100 </tr> |
|
101 </table> |
|
102 </div> |
|
103 <div class="memdoc"> |
|
104 <p><a class="el" href="class_c_connector.html#a0dc0760eb3b611c82f28b184f49d6bd7">NewL()</a></p> |
|
105 <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> |
|
106 |
|
107 <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> |
|
108 |
|
109 </div> |
|
110 </div> |
|
111 <a class="anchor" id="acf4a1927ce9786c1b8010b9cae1d5688"></a><!-- doxytag: member="CConnector::NewLC" ref="acf4a1927ce9786c1b8010b9cae1d5688" args="(MConnectorObserver &aObserver, RSocketServ &aSocketServ)" --> |
|
112 <div class="memitem"> |
|
113 <div class="memproto"> |
|
114 <table class="memname"> |
|
115 <tr> |
|
116 <td class="memname"><a class="el" href="class_c_connector.html">CConnector</a> * CConnector::NewLC </td> |
|
117 <td>(</td> |
|
118 <td class="paramtype"><a class="el" href="class_m_connector_observer.html">MConnectorObserver</a> & </td> |
|
119 <td class="paramname"> <em>aObserver</em>, </td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td class="paramkey"></td> |
|
123 <td></td> |
|
124 <td class="paramtype">RSocketServ & </td> |
|
125 <td class="paramname"> <em>aSocketServ</em></td><td> </td> |
|
126 </tr> |
|
127 <tr> |
|
128 <td></td> |
|
129 <td>)</td> |
|
130 <td></td><td></td><td><code> [static]</code></td> |
|
131 </tr> |
|
132 </table> |
|
133 </div> |
|
134 <div class="memdoc"> |
|
135 <p><a class="el" href="class_c_connector.html#acf4a1927ce9786c1b8010b9cae1d5688">NewLC()</a> </p> |
|
136 |
|
137 <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> |
|
138 |
|
139 </div> |
|
140 </div> |
|
141 <a class="anchor" id="a3c5da0fe4f3d9a04528d9f6f5a19755b"></a><!-- doxytag: member="CConnector::ConnectL" ref="a3c5da0fe4f3d9a04528d9f6f5a19755b" args="(THostName aName, TBTDevAddr aAddr, TInt aPort)" --> |
|
142 <div class="memitem"> |
|
143 <div class="memproto"> |
|
144 <table class="memname"> |
|
145 <tr> |
|
146 <td class="memname">TRequestStatus CConnector::ConnectL </td> |
|
147 <td>(</td> |
|
148 <td class="paramtype">THostName </td> |
|
149 <td class="paramname"> <em>aName</em>, </td> |
|
150 </tr> |
|
151 <tr> |
|
152 <td class="paramkey"></td> |
|
153 <td></td> |
|
154 <td class="paramtype">TBTDevAddr </td> |
|
155 <td class="paramname"> <em>aAddr</em>, </td> |
|
156 </tr> |
|
157 <tr> |
|
158 <td class="paramkey"></td> |
|
159 <td></td> |
|
160 <td class="paramtype">TInt </td> |
|
161 <td class="paramname"> <em>aPort</em></td><td> </td> |
|
162 </tr> |
|
163 <tr> |
|
164 <td></td> |
|
165 <td>)</td> |
|
166 <td></td><td></td><td></td> |
|
167 </tr> |
|
168 </table> |
|
169 </div> |
|
170 <div class="memdoc"> |
|
171 <p><a class="el" href="class_c_connector.html#a3c5da0fe4f3d9a04528d9f6f5a19755b">ConnectL()</a></p> |
|
172 <p>discussion Creates a connection to given remote address on given port.</p> |
|
173 <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> |
|
174 <p>return the status of connection attempt </p> |
|
175 |
|
176 <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> |
|
177 |
|
178 </div> |
|
179 </div> |
|
180 <a class="anchor" id="aa7bef8230682e64f354bec585426fdb5"></a><!-- doxytag: member="CConnector::Disconnect" ref="aa7bef8230682e64f354bec585426fdb5" args="()" --> |
|
181 <div class="memitem"> |
|
182 <div class="memproto"> |
|
183 <table class="memname"> |
|
184 <tr> |
|
185 <td class="memname">void CConnector::Disconnect </td> |
|
186 <td>(</td> |
|
187 <td class="paramname"></td> |
|
188 <td> ) </td> |
|
189 <td></td> |
|
190 </tr> |
|
191 </table> |
|
192 </div> |
|
193 <div class="memdoc"> |
|
194 <p><a class="el" href="class_c_connector.html#aa7bef8230682e64f354bec585426fdb5">Disconnect()</a></p> |
|
195 <p>discussion Disconnects connector from slave. </p> |
|
196 |
|
197 <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> |
|
198 |
|
199 </div> |
|
200 </div> |
|
201 <a class="anchor" id="a2eecddc3d4f5ff157d17820c0add199b"></a><!-- doxytag: member="CConnector::SendData" ref="a2eecddc3d4f5ff157d17820c0add199b" args="(const TDesC8 &)" --> |
|
202 <div class="memitem"> |
|
203 <div class="memproto"> |
|
204 <table class="memname"> |
|
205 <tr> |
|
206 <td class="memname">void CConnector::SendData </td> |
|
207 <td>(</td> |
|
208 <td class="paramtype">const TDesC8 & </td> |
|
209 <td class="paramname"> <em>aData</em></td> |
|
210 <td> ) </td> |
|
211 <td></td> |
|
212 </tr> |
|
213 </table> |
|
214 </div> |
|
215 <div class="memdoc"> |
|
216 <p>SendDataL()</p> |
|
217 <p>discussion Sends given data to slave.</p> |
|
218 <p>param aData the message to send to slave. </p> |
|
219 |
|
220 <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> |
|
221 |
|
222 </div> |
|
223 </div> |
|
224 <a class="anchor" id="ad8e86b9b23abc394fc0451a3ea82c81a"></a><!-- doxytag: member="CConnector::RunL" ref="ad8e86b9b23abc394fc0451a3ea82c81a" args="()" --> |
|
225 <div class="memitem"> |
|
226 <div class="memproto"> |
|
227 <table class="memname"> |
|
228 <tr> |
|
229 <td class="memname">void CConnector::RunL </td> |
|
230 <td>(</td> |
|
231 <td class="paramname"></td> |
|
232 <td> ) </td> |
|
233 <td><code> [protected]</code></td> |
|
234 </tr> |
|
235 </table> |
|
236 </div> |
|
237 <div class="memdoc"> |
|
238 <p><a class="el" href="class_c_connector.html#ad8e86b9b23abc394fc0451a3ea82c81a">RunL()</a></p> |
|
239 <p>discussion Handle the active objects request completion. </p> |
|
240 |
|
241 <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> |
|
242 |
|
243 </div> |
|
244 </div> |
|
245 <a class="anchor" id="ad00a6a26fea8373614265186057cf042"></a><!-- doxytag: member="CConnector::DoCancel" ref="ad00a6a26fea8373614265186057cf042" args="()" --> |
|
246 <div class="memitem"> |
|
247 <div class="memproto"> |
|
248 <table class="memname"> |
|
249 <tr> |
|
250 <td class="memname">void CConnector::DoCancel </td> |
|
251 <td>(</td> |
|
252 <td class="paramname"></td> |
|
253 <td> ) </td> |
|
254 <td><code> [protected]</code></td> |
|
255 </tr> |
|
256 </table> |
|
257 </div> |
|
258 <div class="memdoc"> |
|
259 <p><a class="el" href="class_c_connector.html#ad00a6a26fea8373614265186057cf042">DoCancel()</a></p> |
|
260 <p>discussion Cancels the outstanding request on active object. </p> |
|
261 |
|
262 <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> |
|
263 |
|
264 </div> |
|
265 </div> |
|
266 </div> |
|
267 <hr size="1"/><address style="text-align: right;"><small>Generated by |
|
268 <a href="http://www.doxygen.org/index.html"> |
|
269 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address> |
|
270 </body> |
|
271 </html> |