<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: socketport.h Source File</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.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul></div>
<h1>socketport.h</h1><a href="socketport_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (C) 1999-2005 Open Source Telecom Corporation.</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// This program is free software; you can redistribute it and/or modify</span>
<a name="l00004"></a>00004 <span class="comment">// it under the terms of the GNU General Public License as published by</span>
<a name="l00005"></a>00005 <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00006"></a>00006 <span class="comment">// (at your option) any later version.</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// This program is distributed in the hope that it will be useful,</span>
<a name="l00009"></a>00009 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00010"></a>00010 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00011"></a>00011 <span class="comment">// GNU General Public License for more details.</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// You should have received a copy of the GNU General Public License</span>
<a name="l00014"></a>00014 <span class="comment">// along with this program; if not, write to the Free Software</span>
<a name="l00015"></a>00015 <span class="comment">// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017 <span class="comment">// As a special exception, you may use this file as part of a free software</span>
<a name="l00018"></a>00018 <span class="comment">// library without restriction. Specifically, if other files instantiate</span>
<a name="l00019"></a>00019 <span class="comment">// templates or use macros or inline functions from this file, or you compile</span>
<a name="l00020"></a>00020 <span class="comment">// this file and link it with other files to produce an executable, this</span>
<a name="l00021"></a>00021 <span class="comment">// file does not by itself cause the resulting executable to be covered by</span>
<a name="l00022"></a>00022 <span class="comment">// the GNU General Public License. This exception does not however </span>
<a name="l00023"></a>00023 <span class="comment">// invalidate any other reasons why the executable file might be covered by</span>
<a name="l00024"></a>00024 <span class="comment">// the GNU General Public License. </span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// This exception applies only to the code released under the name GNU</span>
<a name="l00027"></a>00027 <span class="comment">// Common C++. If you copy code from other releases into a copy of GNU</span>
<a name="l00028"></a>00028 <span class="comment">// Common C++, as the General Public License permits, the exception does</span>
<a name="l00029"></a>00029 <span class="comment">// not apply to the code that you add in this way. To avoid misleading</span>
<a name="l00030"></a>00030 <span class="comment">// anyone as to the status of such modified files, you must delete</span>
<a name="l00031"></a>00031 <span class="comment">// this exception notice from them.</span>
<a name="l00032"></a>00032 <span class="comment">//</span>
<a name="l00033"></a>00033 <span class="comment">// If you write modifications of your own for GNU Common C++, it is your choice</span>
<a name="l00034"></a>00034 <span class="comment">// whether to permit this exception to apply to your modifications.</span>
<a name="l00035"></a>00035 <span class="comment">// If you do not wish that, delete this exception notice.</span>
<a name="l00036"></a>00036 <span class="comment">//</span>
<a name="l00037"></a>00037
<a name="l00043"></a>00043 <span class="preprocessor">#ifndef CCXX_SOCKETPORT_H_</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define CCXX_SOCKETPORT_H_</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#ifndef CCXX_ADDRESS_H_</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="address_8h.html">cc++/address.h</a>></span>
<a name="l00048"></a>00048 <span class="preprocessor">#endif</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050 <span class="preprocessor">#ifndef CCXX_SOCKET_H_</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="socket_8h.html">cc++/socket.h</a>></span>
<a name="l00052"></a>00052 <span class="preprocessor">#endif</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span>
<a name="l00054"></a>00054 <span class="preprocessor">#ifdef CCXX_NAMESPACES</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="keyword">namespace </span>ost {
<a name="l00056"></a>00056 <span class="preprocessor">#endif</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00058"></a><a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">00058</a> <span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> SocketPort;
<a name="l00059"></a><a class="code" href="namespaceost.html#5b999accae7692fd2abbc9654a00eb8c">00059</a> <span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> SocketService;
<a name="l00060"></a>00060
<a name="l00080"></a><a class="code" href="classost_1_1_socket_port.html">00080</a> <span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> SocketPort : <span class="keyword">public</span> <a class="code" href="classost_1_1_socket.html">Socket</a>, <span class="keyword">public</span> <a class="code" href="classost_1_1_timer_port.html">TimerPort</a>
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 <span class="keyword">private</span>:
<a name="l00083"></a>00083 SocketPort *next, *prev;
<a name="l00084"></a>00084 SocketService *service;
<a name="l00085"></a>00085 <span class="preprocessor">#ifndef WIN32</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span> <span class="keyword">struct </span>timeval porttimer;
<a name="l00087"></a>00087 <span class="preprocessor">#ifdef USE_POLL</span>
<a name="l00088"></a>00088 <span class="preprocessor"></span> <span class="keyword">struct </span>pollfd * ufd;
<a name="l00089"></a>00089 <span class="preprocessor">#endif</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span> <a class="code" href="serial_8h.html#069bb8cb95b0528d5ce0304bb5561a40">HANDLE</a> event;
<a name="l00092"></a>00092 <span class="preprocessor">#endif</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span> <span class="keywordtype">bool</span> detect_pending;
<a name="l00094"></a>00094 <span class="keywordtype">bool</span> detect_output;
<a name="l00095"></a>00095 <span class="keywordtype">bool</span> detect_disconnect;
<a name="l00096"></a>00096
<a name="l00097"></a><a class="code" href="classost_1_1_socket_port.html#4b89563fb4861da0276ccd214f93122d">00097</a> <span class="keyword">friend</span> <span class="keyword">class </span>SocketService;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">protected</span>:
<a name="l00108"></a>00108 <a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">SocketPort</a>(SocketService *svc, <a class="code" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &tcp);
<a name="l00109"></a>00109 <span class="preprocessor">#ifdef CCXX_IPV6</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span> <a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">SocketPort</a>(SocketService *svc, <a class="code" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> &tcp);
<a name="l00111"></a>00111 <span class="preprocessor">#endif</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span>
<a name="l00121"></a>00121 <a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">SocketPort</a>(SocketService *svc, <span class="keyword">const</span> <a class="code" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &ia, <a class="code" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port);
<a name="l00122"></a>00122 <span class="preprocessor">#ifdef CCXX_IPV6</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span> <a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">SocketPort</a>(SocketService *svc, <span class="keyword">const</span> <a class="code" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &ia, <a class="code" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port);
<a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
<a name="l00125"></a>00125 <span class="preprocessor"></span>
<a name="l00139"></a>00139 <a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">SocketPort</a>(SocketService *svc, <span class="keyword">const</span> <a class="code" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &ih, <a class="code" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port);
<a name="l00140"></a>00140 <span class="preprocessor">#ifdef CCXX_IPV6</span>
<a name="l00141"></a>00141 <span class="preprocessor"></span> <a class="code" href="namespaceost.html#0120970550868f111b2d9cc7054526f7">SocketPort</a>(SocketService *svc, <span class="keyword">const</span> <a class="code" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &ih, <a class="code" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port);
<a name="l00142"></a>00142 <span class="preprocessor">#endif</span>
<a name="l00143"></a>00143 <span class="preprocessor"></span>
<a name="l00149"></a>00149 <span class="keywordtype">void</span> attach( SocketService* svc );
<a name="l00150"></a>00150
<a name="l00151"></a>00151
<a name="l00156"></a>00156 <span class="keyword">virtual</span> ~SocketPort();
<a name="l00157"></a>00157
<a name="l00162"></a>00162 <span class="keywordtype">void</span> setDetectPending( <span class="keywordtype">bool</span> );
<a name="l00163"></a>00163
<a name="l00167"></a><a class="code" href="classost_1_1_socket_port.html#f1e65f719e39f651ad8789183f8905c9">00167</a> <span class="keywordtype">bool</span> getDetectPending( <span class="keywordtype">void</span> )<span class="keyword"> const</span>
<a name="l00168"></a>00168 <span class="keyword"> </span>{ <span class="keywordflow">return</span> detect_pending; }
<a name="l00169"></a>00169
<a name="l00174"></a>00174 <span class="keywordtype">void</span> setDetectOutput( <span class="keywordtype">bool</span> );
<a name="l00175"></a>00175
<a name="l00179"></a><a class="code" href="classost_1_1_socket_port.html#80a16072f163a5a49341c4fd495fd9b1">00179</a> <span class="keywordtype">bool</span> getDetectOutput( <span class="keywordtype">void</span> )<span class="keyword"> const</span>
<a name="l00180"></a>00180 <span class="keyword"> </span>{ <span class="keywordflow">return</span> detect_output; }
<a name="l00181"></a>00181
<a name="l00186"></a>00186 <span class="keyword">virtual</span> <span class="keywordtype">void</span> expired(<span class="keywordtype">void</span>);
<a name="l00187"></a>00187
<a name="l00192"></a>00192 <span class="keyword">virtual</span> <span class="keywordtype">void</span> pending(<span class="keywordtype">void</span>);
<a name="l00193"></a>00193
<a name="l00198"></a>00198 <span class="keyword">virtual</span> <span class="keywordtype">void</span> output(<span class="keywordtype">void</span>);
<a name="l00199"></a>00199
<a name="l00204"></a>00204 <span class="keyword">virtual</span> <span class="keywordtype">void</span> disconnect(<span class="keywordtype">void</span>);
<a name="l00205"></a>00205
<a name="l00216"></a>00216 Error connect(<span class="keyword">const</span> <a class="code" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &ia, <a class="code" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port);
<a name="l00217"></a>00217 <span class="preprocessor">#ifdef CCXX_IPV6</span>
<a name="l00218"></a>00218 <span class="preprocessor"></span> Error connect(<span class="keyword">const</span> <a class="code" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &ia, <a class="code" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port);
<a name="l00219"></a>00219 <span class="preprocessor">#endif</span>
<a name="l00220"></a>00220 <span class="preprocessor"></span>
<a name="l00230"></a><a class="code" href="classost_1_1_socket_port.html#9218e4528f5bdf4215200e2040eefe5b">00230</a> <span class="keyword">inline</span> ssize_t send(<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, size_t len)
<a name="l00231"></a>00231 {<span class="keywordflow">return</span> _IORET64 ::send(so, (<span class="keyword">const</span> <span class="keywordtype">char</span> *)buf, _IOLEN64 len, 0);};
<a name="l00232"></a>00232
<a name="l00241"></a><a class="code" href="classost_1_1_socket_port.html#872c38a65b17113a580af345946146d7">00241</a> <span class="keyword">inline</span> ssize_t receive(<span class="keywordtype">void</span> *buf, size_t len)
<a name="l00242"></a>00242 {<span class="keywordflow">return</span> _IORET64 ::recv(so, (<span class="keywordtype">char</span> *)buf, _IOLEN64 len, 0);};
<a name="l00243"></a>00243
<a name="l00252"></a><a class="code" href="classost_1_1_socket_port.html#fb7798f8cc7e50d42ad82a1537e89c63">00252</a> <span class="keyword">inline</span> ssize_t peek(<span class="keywordtype">void</span> *buf, size_t len)
<a name="l00253"></a>00253 {<span class="keywordflow">return</span> _IORET64 ::recv(so, (<span class="keywordtype">char</span> *)buf, _IOLEN64 len, MSG_PEEK);};
<a name="l00254"></a>00254
<a name="l00255"></a>00255 <span class="keyword">public</span>:
<a name="l00263"></a>00263 <span class="keywordtype">void</span> setTimer(<a class="code" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout = 0);
<a name="l00264"></a>00264
<a name="l00272"></a>00272 <span class="keywordtype">void</span> incTimer(<a class="code" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout);
<a name="l00273"></a>00273 };
<a name="l00274"></a>00274
<a name="l00287"></a><a class="code" href="classost_1_1_socket_service.html">00287</a> <span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> <a class="code" href="namespaceost.html#5b999accae7692fd2abbc9654a00eb8c">SocketService</a> : <span class="keyword">public</span> <a class="code" href="classost_1_1_thread.html">Thread</a>, <span class="keyword">private</span> <a class="code" href="classost_1_1_mutex.html">Mutex</a>
<a name="l00288"></a>00288 {
<a name="l00289"></a>00289 <span class="keyword">private</span>:
<a name="l00290"></a>00290 <span class="preprocessor">#ifndef WIN32</span>
<a name="l00291"></a>00291 <span class="preprocessor"></span> fd_set connect;
<a name="l00292"></a>00292 <span class="keywordtype">int</span> iosync[2];
<a name="l00293"></a>00293 <span class="keywordtype">int</span> hiwater;
<a name="l00294"></a>00294 <span class="preprocessor">#else</span>
<a name="l00295"></a>00295 <span class="preprocessor"></span> <span class="comment">// private syncronization class</span>
<a name="l00296"></a>00296 <span class="keyword">class </span>Sync;
<a name="l00297"></a>00297 Sync* sync;
<a name="l00298"></a>00298 <span class="preprocessor">#endif</span>
<a name="l00299"></a>00299 <span class="preprocessor"></span> <span class="keywordtype">int</span> <span class="keyword">volatile</span> count;
<a name="l00300"></a>00300 SocketPort* <span class="keyword">volatile</span> first, *last;
<a name="l00301"></a>00301
<a name="l00307"></a>00307 <span class="keywordtype">void</span> attach(SocketPort *port);
<a name="l00313"></a>00313 <span class="keywordtype">void</span> detach(SocketPort *port);
<a name="l00314"></a>00314
<a name="l00318"></a>00318 <span class="keywordtype">void</span> run(<span class="keywordtype">void</span>);
<a name="l00319"></a>00319
<a name="l00320"></a><a class="code" href="classost_1_1_socket_service.html#9884a27b35e263e19e4acf2cb06c4071">00320</a> <span class="keyword">friend</span> <span class="keyword">class </span>SocketPort;
<a name="l00321"></a>00321
<a name="l00322"></a>00322 <span class="keyword">protected</span>:
<a name="l00328"></a>00328 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onUpdate(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> buf);
<a name="l00329"></a>00329
<a name="l00335"></a>00335 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onEvent(<span class="keywordtype">void</span>);
<a name="l00336"></a>00336
<a name="l00344"></a>00344 <span class="keyword">virtual</span> <span class="keywordtype">void</span> onCallback(SocketPort *port);
<a name="l00345"></a>00345
<a name="l00346"></a>00346 <span class="keyword">public</span>:
<a name="l00357"></a>00357 <span class="keywordtype">void</span> update(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> flag = 0xff);
<a name="l00358"></a>00358
<a name="l00367"></a>00367 <a class="code" href="namespaceost.html#5b999accae7692fd2abbc9654a00eb8c">SocketService</a>(<span class="keywordtype">int</span> pri = 0, size_t stack = 0, <span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span> = NULL);
<a name="l00368"></a>00368
<a name="l00373"></a>00373 <span class="keyword">virtual</span> ~<a class="code" href="namespaceost.html#5b999accae7692fd2abbc9654a00eb8c">SocketService</a>();
<a name="l00374"></a>00374
<a name="l00381"></a><a class="code" href="classost_1_1_socket_service.html#870e3205e044e2862b9f17739ba8172c">00381</a> <span class="keyword">inline</span> <span class="keywordtype">int</span> getCount(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
<a name="l00382"></a>00382 <span class="keyword"> </span>{<span class="keywordflow">return</span> count;};
<a name="l00383"></a>00383 };
<a name="l00384"></a>00384
<a name="l00385"></a>00385 <span class="preprocessor">#ifdef CCXX_NAMESPACES</span>
<a name="l00386"></a>00386 <span class="preprocessor"></span>}
<a name="l00387"></a>00387 <span class="preprocessor">#endif</span>
<a name="l00388"></a>00388 <span class="preprocessor"></span>
<a name="l00389"></a>00389 <span class="preprocessor">#endif</span>
<a name="l00390"></a>00390 <span class="preprocessor"></span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:55 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
