17:39
[skypekit:skypekit.git] / skypekit_2.0.0.190_29281_CB30 / interfaces / skype / cpp_embedded / documentation / html / class_s_e_t_c_p_transport.html
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>SkypeKit C++ Wrapper: Main Page</title>
6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
7 <link href="islander.css" rel="stylesheet" type="text/css"/>
8 </head>
9 <body>
10 <img src="..\skypekit.png" align="right">
11 <!-- Generated by Doxygen 1.6.2 -->
12 <script type="text/javascript">
13 <!--
14 function changeDisplayState (e){
15   var num=this.id.replace(/[^[0-9]/g,'');
16   var button=this.firstChild;
17   var sectionDiv=document.getElementById('dynsection'+num);
18   if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
19     sectionDiv.style.display='block';
20     button.src='open.gif';
21   }else{
22     sectionDiv.style.display='none';
23     button.src='closed.gif';
24   }
25 }
26 function initDynSections(){
27   var divs=document.getElementsByTagName('div');
28   var sectionCounter=1;
29   for(var i=0;i<divs.length-1;i++){
30     if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
31       var header=divs[i];
32       var section=divs[i+1];
33       var button=header.firstChild;
34       if (button!='IMG'){
35         divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
36         button=document.createElement('img');
37         divs[i].insertBefore(button,divs[i].firstChild);
38       }
39       header.style.cursor='pointer';
40       header.onclick=changeDisplayState;
41       header.id='dynheader'+sectionCounter;
42       button.src='closed.gif';
43       section.id='dynsection'+sectionCounter;
44       section.style.display='none';
45       section.style.marginLeft='14px';
46       sectionCounter++;
47     }
48   }
49 }
50 window.onload = initDynSections;
51 -->
52 </script>
53 <div class="navigation" id="top">
54   <div class="tabs">
55     <ul>
56       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
57       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
58       <li><a href="files.html"><span>Files</span></a></li>
59       <li><a href="examples.html"><span>Examples</span></a></li>
60     </ul>
61   </div>
62   <div class="tabs">
63     <ul>
64       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
65       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
66       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
67     </ul>
68   </div>
69 </div>
70 <div class="contents">
71 <h1>SETCPTransport Class Reference</h1><!-- doxytag: class="SETCPTransport" --><!-- doxytag: inherits="SETransport" -->
72 <p>TCP transport to skypekit.  
73 <a href="#_details">More...</a></p>
74
75 <p><code>#include &lt;<a class="el" href="skype-tcp-transport_8h_source.html">skype-tcp-transport.h</a>&gt;</code></p>
76 <div class="dynheader">
77 Inheritance diagram for SETCPTransport:</div>
78 <div class="dynsection">
79 <div class="center"><img src="class_s_e_t_c_p_transport__inherit__graph.png" border="0" usemap="#_s_e_t_c_p_transport_inherit__map" alt="Inheritance graph"/></div>
80 <map name="_s_e_t_c_p_transport_inherit__map" id="_s_e_t_c_p_transport_inherit__map">
81 <area shape="rect" href="class_s_e_transport.html" title="Abstract interface for transport layer." alt="" coords="16,7,149,226"/></map>
82 </div>
83 <div class="dynheader">
84 Collaboration diagram for SETCPTransport:</div>
85 <div class="dynsection">
86 <div class="center"><img src="class_s_e_t_c_p_transport__coll__graph.png" border="0" usemap="#_s_e_t_c_p_transport_coll__map" alt="Collaboration graph"/></div>
87 <map name="_s_e_t_c_p_transport_coll__map" id="_s_e_t_c_p_transport_coll__map">
88 <area shape="rect" href="class_s_e_transport.html" title="Abstract interface for transport layer." alt="" coords="16,7,149,226"/></map>
89 </div>
90
91 <p><a href="class_s_e_t_c_p_transport-members.html">List of all members.</a></p>
92 <table border="0" cellpadding="0" cellspacing="0">
93 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
94 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a4f78eb9531ae32806bc7efd456e2bf85">SETCPTransport</a> (const <a class="el" href="class_s_e_string.html">SEString</a> &amp;addr, int port)</td></tr>
95 <tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a4538c95504ad07f6b1047fd819ddc523">~SETCPTransport</a> ()</td></tr>
96 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a242d1aef375280b856f6601d3ab1ae38">connect</a> ()</td></tr>
97 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a2ee5d03c91ffc7e898f9113642bc3fbc">disconnect</a> ()</td></tr>
98 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disconnects from skypekit.  <a href="#a2ee5d03c91ffc7e898f9113642bc3fbc"></a><br/></td></tr>
99 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a3580adc084a567b049d5e0b721e5937d">isConnected</a> () const </td></tr>
100 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if the connection to skypekit is still there.  <a href="#a3580adc084a567b049d5e0b721e5937d"></a><br/></td></tr>
101 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a2c14f6240ac1de67fd0bc1e9ba6f1e00">getSocket</a> () const </td></tr>
102 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the socket descriptor which can be used to manually call select on. If the implementation doesn't support this functionality it returns -1.  <a href="#a2c14f6240ac1de67fd0bc1e9ba6f1e00"></a><br/></td></tr>
103 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#aee29c4ff6ccfb6291a8da93dc008a7f3">read</a> (unsigned int num_bytes, char *dest)</td></tr>
104 <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_e_t_c_p_transport.html#a2dff69ef79cb49c986bd41ee6ab1e1ec">write</a> (unsigned int num_bytes, const char *dest)</td></tr>
105 </table>
106 <hr/><a name="_details"></a><h2>Detailed Description</h2>
107 <p>TCP transport to skypekit. </p>
108 <p>Use this only if Unix sockets are not supported on your platform. </p>
109 <dl><dt><b>Examples: </b></dt><dd>
110 <p><a class="el" href="tutorial__1_8cpp-example.html#_a1">tutorial_1.cpp</a>, <a class="el" href="tutorial__10_8cpp-example.html#_a6">tutorial_10.cpp</a>, <a class="el" href="tutorial__2_8cpp-example.html#_a16">tutorial_2.cpp</a>, <a class="el" href="tutorial__3_8cpp-example.html#_a11">tutorial_3.cpp</a>, <a class="el" href="tutorial__4_8cpp-example.html#_a31">tutorial_4.cpp</a>, <a class="el" href="tutorial__5_8cpp-example.html#_a17">tutorial_5.cpp</a>, <a class="el" href="tutorial__6_8cpp-example.html#_a8">tutorial_6.cpp</a>, <a class="el" href="tutorial__7_8cpp-example.html#_a9">tutorial_7.cpp</a>, <a class="el" href="tutorial__8_8cpp-example.html#_a15">tutorial_8.cpp</a>, and <a class="el" href="tutorial__9_8cpp-example.html#_a5">tutorial_9.cpp</a>.</p>
111 </dd>
112 </dl>
113 <p>Definition at line <a class="el" href="skype-tcp-transport_8h_source.html#l00015">15</a> of file <a class="el" href="skype-tcp-transport_8h_source.html">skype-tcp-transport.h</a>.</p>
114 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
115 <a class="anchor" id="a4f78eb9531ae32806bc7efd456e2bf85"></a><!-- doxytag: member="SETCPTransport::SETCPTransport" ref="a4f78eb9531ae32806bc7efd456e2bf85" args="(const SEString &amp;addr, int port)" -->
116 <div class="memitem">
117 <div class="memproto">
118       <table class="memname">
119         <tr>
120           <td class="memname">SETCPTransport::SETCPTransport </td>
121           <td>(</td>
122           <td class="paramtype">const <a class="el" href="class_s_e_string.html">SEString</a> &amp;&nbsp;</td>
123           <td class="paramname"> <em>addr</em>, </td>
124         </tr>
125         <tr>
126           <td class="paramkey"></td>
127           <td></td>
128           <td class="paramtype">int&nbsp;</td>
129           <td class="paramname"> <em>port</em></td><td>&nbsp;</td>
130         </tr>
131         <tr>
132           <td></td>
133           <td>)</td>
134           <td></td><td></td><td></td>
135         </tr>
136       </table>
137 </div>
138 <div class="memdoc">
139 <dl><dt><b>Parameters:</b></dt><dd>
140   <table border="0" cellspacing="2" cellpadding="0">
141     <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>Address where skypekit is running ("127.0.0.1" in general) </td></tr>
142     <tr><td valign="top"></td><td valign="top"><em>port</em>&nbsp;</td><td>Port where skypekit is running </td></tr>
143   </table>
144   </dd>
145 </dl>
146
147 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00041">41</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
148
149 <p>References <a class="el" href="skype-transport_8h_source.html#l00044">SETransport::LOG()</a>.</p>
150
151 </div>
152 </div>
153 <a class="anchor" id="a4538c95504ad07f6b1047fd819ddc523"></a><!-- doxytag: member="SETCPTransport::~SETCPTransport" ref="a4538c95504ad07f6b1047fd819ddc523" args="()" -->
154 <div class="memitem">
155 <div class="memproto">
156       <table class="memname">
157         <tr>
158           <td class="memname">SETCPTransport::~SETCPTransport </td>
159           <td>(</td>
160           <td class="paramname"></td>
161           <td>&nbsp;)&nbsp;</td>
162           <td><code> [virtual]</code></td>
163         </tr>
164       </table>
165 </div>
166 <div class="memdoc">
167
168 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00058">58</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
169
170 </div>
171 </div>
172 <hr/><h2>Member Function Documentation</h2>
173 <a class="anchor" id="a242d1aef375280b856f6601d3ab1ae38"></a><!-- doxytag: member="SETCPTransport::connect" ref="a242d1aef375280b856f6601d3ab1ae38" args="()" -->
174 <div class="memitem">
175 <div class="memproto">
176       <table class="memname">
177         <tr>
178           <td class="memname">bool SETCPTransport::connect </td>
179           <td>(</td>
180           <td class="paramname"></td>
181           <td>&nbsp;)&nbsp;</td>
182           <td><code> [virtual]</code></td>
183         </tr>
184       </table>
185 </div>
186 <div class="memdoc">
187
188 <p>Implements <a class="el" href="class_s_e_transport.html#a21af4c91e511ac90faa8d81bbc75b768">SETransport</a>.</p>
189
190 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00062">62</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
191
192 <p>References <a class="el" href="skype-transport_8h_source.html#l00044">SETransport::LOG()</a>.</p>
193
194 </div>
195 </div>
196 <a class="anchor" id="a2ee5d03c91ffc7e898f9113642bc3fbc"></a><!-- doxytag: member="SETCPTransport::disconnect" ref="a2ee5d03c91ffc7e898f9113642bc3fbc" args="()" -->
197 <div class="memitem">
198 <div class="memproto">
199       <table class="memname">
200         <tr>
201           <td class="memname">void SETCPTransport::disconnect </td>
202           <td>(</td>
203           <td class="paramname"></td>
204           <td>&nbsp;)&nbsp;</td>
205           <td><code> [virtual]</code></td>
206         </tr>
207       </table>
208 </div>
209 <div class="memdoc">
210
211 <p>Disconnects from skypekit. </p>
212
213 <p>Implements <a class="el" href="class_s_e_transport.html#ad72121a97ce0cab2e697b0f82512b2da">SETransport</a>.</p>
214
215 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00088">88</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
216
217 <p>References <a class="el" href="skype-transport_8h_source.html#l00044">SETransport::LOG()</a>.</p>
218
219 </div>
220 </div>
221 <a class="anchor" id="a2c14f6240ac1de67fd0bc1e9ba6f1e00"></a><!-- doxytag: member="SETCPTransport::getSocket" ref="a2c14f6240ac1de67fd0bc1e9ba6f1e00" args="() const " -->
222 <div class="memitem">
223 <div class="memproto">
224       <table class="memname">
225         <tr>
226           <td class="memname">int SETCPTransport::getSocket </td>
227           <td>(</td>
228           <td class="paramname"></td>
229           <td>&nbsp;)&nbsp;</td>
230           <td> const<code> [virtual]</code></td>
231         </tr>
232       </table>
233 </div>
234 <div class="memdoc">
235
236 <p>Returns the socket descriptor which can be used to manually call select on. If the implementation doesn't support this functionality it returns -1. </p>
237
238 <p>Implements <a class="el" href="class_s_e_transport.html#a2a2ea09333e9a0a9cb7c76042becbf4f">SETransport</a>.</p>
239
240 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00165">165</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
241
242 </div>
243 </div>
244 <a class="anchor" id="a3580adc084a567b049d5e0b721e5937d"></a><!-- doxytag: member="SETCPTransport::isConnected" ref="a3580adc084a567b049d5e0b721e5937d" args="() const " -->
245 <div class="memitem">
246 <div class="memproto">
247       <table class="memname">
248         <tr>
249           <td class="memname">bool SETCPTransport::isConnected </td>
250           <td>(</td>
251           <td class="paramname"></td>
252           <td>&nbsp;)&nbsp;</td>
253           <td> const<code> [virtual]</code></td>
254         </tr>
255       </table>
256 </div>
257 <div class="memdoc">
258
259 <p>Check if the connection to skypekit is still there. </p>
260
261 <p>Implements <a class="el" href="class_s_e_transport.html#a75af518d0ee4247dc9a765ac4db24d72">SETransport</a>.</p>
262
263 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00160">160</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
264
265 </div>
266 </div>
267 <a class="anchor" id="aee29c4ff6ccfb6291a8da93dc008a7f3"></a><!-- doxytag: member="SETCPTransport::read" ref="aee29c4ff6ccfb6291a8da93dc008a7f3" args="(unsigned int num_bytes, char *dest)" -->
268 <div class="memitem">
269 <div class="memproto">
270       <table class="memname">
271         <tr>
272           <td class="memname">bool SETCPTransport::read </td>
273           <td>(</td>
274           <td class="paramtype">unsigned int&nbsp;</td>
275           <td class="paramname"> <em>num_bytes</em>, </td>
276         </tr>
277         <tr>
278           <td class="paramkey"></td>
279           <td></td>
280           <td class="paramtype">char *&nbsp;</td>
281           <td class="paramname"> <em>dest</em></td><td>&nbsp;</td>
282         </tr>
283         <tr>
284           <td></td>
285           <td>)</td>
286           <td></td><td></td><td><code> [virtual]</code></td>
287         </tr>
288       </table>
289 </div>
290 <div class="memdoc">
291
292 <p>Implements <a class="el" href="class_s_e_transport.html#a6ac0733481dec47755d90d1f410c16d5">SETransport</a>.</p>
293
294 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00100">100</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
295
296 <p>References <a class="el" href="skype-tcp-transport_8cpp_source.html#l00088">disconnect()</a>, <a class="el" href="skype-transport_8h_source.html#l00044">SETransport::LOG()</a>, and <a class="el" href="skype-socket-transport_8cpp_source.html#l00042">TEMP_FAILURE_RETRY</a>.</p>
297
298 </div>
299 </div>
300 <a class="anchor" id="a2dff69ef79cb49c986bd41ee6ab1e1ec"></a><!-- doxytag: member="SETCPTransport::write" ref="a2dff69ef79cb49c986bd41ee6ab1e1ec" args="(unsigned int num_bytes, const char *dest)" -->
301 <div class="memitem">
302 <div class="memproto">
303       <table class="memname">
304         <tr>
305           <td class="memname">bool SETCPTransport::write </td>
306           <td>(</td>
307           <td class="paramtype">unsigned int&nbsp;</td>
308           <td class="paramname"> <em>num_bytes</em>, </td>
309         </tr>
310         <tr>
311           <td class="paramkey"></td>
312           <td></td>
313           <td class="paramtype">const char *&nbsp;</td>
314           <td class="paramname"> <em>dest</em></td><td>&nbsp;</td>
315         </tr>
316         <tr>
317           <td></td>
318           <td>)</td>
319           <td></td><td></td><td><code> [virtual]</code></td>
320         </tr>
321       </table>
322 </div>
323 <div class="memdoc">
324
325 <p>Implements <a class="el" href="class_s_e_transport.html#a843aa0ef28b3e3bd82faf858cda5db85">SETransport</a>.</p>
326
327 <p>Definition at line <a class="el" href="skype-tcp-transport_8cpp_source.html#l00127">127</a> of file <a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a>.</p>
328
329 <p>References <a class="el" href="skype-tcp-transport_8cpp_source.html#l00088">disconnect()</a>, <a class="el" href="skype-transport_8h_source.html#l00044">SETransport::LOG()</a>, and <a class="el" href="skype-socket-transport_8cpp_source.html#l00042">TEMP_FAILURE_RETRY</a>.</p>
330
331 </div>
332 </div>
333 <hr/>The documentation for this class was generated from the following files:<ul>
334 <li><a class="el" href="skype-tcp-transport_8h_source.html">skype-tcp-transport.h</a></li>
335 <li><a class="el" href="skype-tcp-transport_8cpp_source.html">skype-tcp-transport.cpp</a></li>
336 </ul>
337 </div>
338
339 <hr/>   
340                 <p><b>(c) Skype Technologies S.A. Confidential/Proprietary</b></p>              
341                 <p>Last updated: 18 Jun 2010</p>                
342                 </BODY>
343 </HTML>