<!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++: ost::SocketPort Class Reference</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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_socket_port.html">SocketPort</a></div>
<h1>ost::SocketPort Class Reference</h1><!-- doxytag: class="ost::SocketPort" --><!-- doxytag: inherits="ost::Socket,ost::TimerPort" -->The socket port is an internal class which is attached to and then serviced by a specific <a class="el" href="classost_1_1_socket_service.html">SocketService</a> "object".base class for realtime and thread pool serviced protocols.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="socketport_8h-source.html">socketport.h</a>></code>
<p>
<p>Inheritance diagram for ost::SocketPort:
<p><center><img src="classost_1_1_socket_port.png" usemap="#ost::SocketPort_map" border="0" alt=""></center>
<map name="ost::SocketPort_map">
<area href="classost_1_1_socket.html" alt="ost::Socket" shape="rect" coords="0,0,95,24">
<area href="classost_1_1_timer_port.html" alt="ost::TimerPort" shape="rect" coords="105,0,200,24">
</map>
<a href="classost_1_1_socket_port-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#c70f9eae6b6b3625c980fa84180e8151">setTimer</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derived setTimer to notify the service thread pool of change in expected timeout. <a href="#c70f9eae6b6b3625c980fa84180e8151"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#1a7e2bf9e250ea5dcc9e8416aecfbb13">incTimer</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derived incTimer to notify the service thread pool of a change in expected timeout. <a href="#1a7e2bf9e250ea5dcc9e8416aecfbb13"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#3e1456c5b19bb0dc58df0356c055709a">SocketPort</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc, <a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> &tcp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an accepted TCP socket connection from a specific bound TCP server. <a href="#3e1456c5b19bb0dc58df0356c055709a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#edfa5983eefe7e5bca5b3f4c4752ef88">SocketPort</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc, <a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> &tcp)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#e48593fbe73189d452f62ac6864f832f">SocketPort</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc, const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &ia, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects. <a href="#e48593fbe73189d452f62ac6864f832f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#df67a624a192a3eaffbf59891669b1bd">SocketPort</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc, const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &ia, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#c30498e30cd95a8f91c395ebb6e6116a">SocketPort</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc, const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> &ih, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A non-blocking constructor for outbound tcp connections. <a href="#c30498e30cd95a8f91c395ebb6e6116a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#0aee0992af4ffdbda14489ef094a89fd">SocketPort</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc, const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> &ih, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#ed5fbff0b874da8e24add7f6cc50b65e">attach</a> (<a class="el" href="classost_1_1_socket_service.html">SocketService</a> *svc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Attach yourself to the service pool thread object. <a href="#ed5fbff0b874da8e24add7f6cc50b65e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#8c9fcdcd63fae060e12801ddf6ab12db">~SocketPort</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect the socket from the service thread pool and the remote connection. <a href="#8c9fcdcd63fae060e12801ddf6ab12db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#908891c78c95d66424cde91e52299c29">setDetectPending</a> (bool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to indicate if the service thread should monitor pending data for us. <a href="#908891c78c95d66424cde91e52299c29"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#f1e65f719e39f651ad8789183f8905c9">getDetectPending</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current state of the DetectPending flag. <a href="#f1e65f719e39f651ad8789183f8905c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#229b32cb2bf8a306b8882413748eb44c">setDetectOutput</a> (bool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to indicate if output ready monitoring should be performed by the service thread. <a href="#229b32cb2bf8a306b8882413748eb44c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#80a16072f163a5a49341c4fd495fd9b1">getDetectOutput</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current state of the DetectOutput flag. <a href="#80a16072f163a5a49341c4fd495fd9b1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#4d09daed3fe5cb81259985db87add34d">expired</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread pool when the objects timer has expired. <a href="#4d09daed3fe5cb81259985db87add34d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#5e0ec242cfb737db369cbc63abcc06b6">pending</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread pool when input data is pending for this socket. <a href="#5e0ec242cfb737db369cbc63abcc06b6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#f333abc3b9f8f8b2ce4d286d64d54848">output</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread pool when output data is pending for this socket. <a href="#f333abc3b9f8f8b2ce4d286d64d54848"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#7b2a739ee0cb11bc6332010f4cd21552">disconnect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread pool when a disconnect has occured. <a href="#7b2a739ee0cb11bc6332010f4cd21552"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#3601785c16646b7e323cf2d267ce7481">connect</a> (const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> &ia, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect a <a class="el" href="classost_1_1_socket.html">Socket</a> Port to a known peer host. <a href="#3601785c16646b7e323cf2d267ce7481"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#0edb8c155c97099cc0660b3ad1eef77f">connect</a> (const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> &ia, <a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> port)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#9218e4528f5bdf4215200e2040eefe5b">send</a> (const void *buf, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transmit "send" data to a connected peer host. <a href="#9218e4528f5bdf4215200e2040eefe5b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#872c38a65b17113a580af345946146d7">receive</a> (void *buf, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive a message from any host. <a href="#872c38a65b17113a580af345946146d7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#fb7798f8cc7e50d42ad82a1537e89c63">peek</a> (void *buf, size_t len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Examine the content of the next packet. <a href="#fb7798f8cc7e50d42ad82a1537e89c63"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket_port.html#4b89563fb4861da0276ccd214f93122d">SocketService</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The socket port is an internal class which is attached to and then serviced by a specific <a class="el" href="classost_1_1_socket_service.html">SocketService</a> "object".base class for realtime and thread pool serviced protocols.
<p>
Derived versions of this class offer specific functionality for specific protocols. Both Common C++ supporting frameworks and application objects may be derived from related protocol specific base classes.<p>
A special set of classes, "SocketPort" and "SocketService", exist for building realtime streaming media servers on top of UDP and TCP protocols. The "SocketPort" is used to hold a connected or associated TCP or UDP socket which is being "streamed" and which offers callback methods that are invoked from a "SocketService" thread. SocketService's can be pooled into logical thread pools that can service a group of SocketPorts. A millisecond accurate "timer" is associated with each <a class="el" href="classost_1_1_socket_port.html">SocketPort</a> and can be used to time synchronize <a class="el" href="classost_1_1_socket_port.html">SocketPort</a> I/O operations.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="tcpservice_8cpp-example.html#_a46">tcpservice.cpp</a>.</dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3e1456c5b19bb0dc58df0356c055709a"></a><!-- doxytag: member="ost::SocketPort::SocketPort" ref="3e1456c5b19bb0dc58df0356c055709a" args="(SocketService *svc, TCPSocket &tcp)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SocketPort::SocketPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_t_c_p_socket.html">TCPSocket</a> & </td>
<td class="mdname" nowrap> <em>tcp</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct an accepted TCP socket connection from a specific bound TCP server.
<p>
This is meant to derive advanced application specific TCP servers that can be thread pooled.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svc</em> </td><td>pool thread object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tcp</em> </td><td>socket object to accept. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="edfa5983eefe7e5bca5b3f4c4752ef88"></a><!-- doxytag: member="ost::SocketPort::SocketPort" ref="edfa5983eefe7e5bca5b3f4c4752ef88" args="(SocketService *svc, TCPV6Socket &tcp)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SocketPort::SocketPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classost_1_1_t_c_p_v6_socket.html">TCPV6Socket</a> & </td>
<td class="mdname" nowrap> <em>tcp</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="e48593fbe73189d452f62ac6864f832f"></a><!-- doxytag: member="ost::SocketPort::SocketPort" ref="e48593fbe73189d452f62ac6864f832f" args="(SocketService *svc, const IPV4Address &ia, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SocketPort::SocketPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname" nowrap> <em>ia</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svc</em> </td><td>pool thread object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ia</em> </td><td>address of interface to bind. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to bind to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="df67a624a192a3eaffbf59891669b1bd"></a><!-- doxytag: member="ost::SocketPort::SocketPort" ref="df67a624a192a3eaffbf59891669b1bd" args="(SocketService *svc, const IPV6Address &ia, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SocketPort::SocketPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> & </td>
<td class="mdname" nowrap> <em>ia</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="c30498e30cd95a8f91c395ebb6e6116a"></a><!-- doxytag: member="ost::SocketPort::SocketPort" ref="c30498e30cd95a8f91c395ebb6e6116a" args="(SocketService *svc, const IPV4Host &ih, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SocketPort::SocketPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> & </td>
<td class="mdname" nowrap> <em>ih</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A non-blocking constructor for outbound tcp connections.
<p>
To detect when the connection is established, overload <a class="el" href="classost_1_1_socket_port.html#f333abc3b9f8f8b2ce4d286d64d54848">SocketPort::output()</a>. <a class="el" href="classost_1_1_socket_port.html#f333abc3b9f8f8b2ce4d286d64d54848">SocketPort::output()</a> get's called by the <a class="el" href="classost_1_1_socket_service.html">SocketService</a> when the connection is ready, <a class="el" href="classost_1_1_socket_port.html#7b2a739ee0cb11bc6332010f4cd21552">SocketPort::disconnect()</a> when the connect failed. at the moment you should set the socket state to "CONNECTED" when <a class="el" href="classost_1_1_socket_port.html#f333abc3b9f8f8b2ce4d286d64d54848">SocketPort::output()</a> get's called for the first time.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svc</em> </td><td>pool thread object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ih</em> </td><td>addess to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number to connect to. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="0aee0992af4ffdbda14489ef094a89fd"></a><!-- doxytag: member="ost::SocketPort::SocketPort" ref="0aee0992af4ffdbda14489ef094a89fd" args="(SocketService *svc, const IPV6Host &ih, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SocketPort::SocketPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> & </td>
<td class="mdname" nowrap> <em>ih</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="8c9fcdcd63fae060e12801ddf6ab12db"></a><!-- doxytag: member="ost::SocketPort::~SocketPort" ref="8c9fcdcd63fae060e12801ddf6ab12db" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::SocketPort::~SocketPort </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Disconnect the socket from the service thread pool and the remote connection.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ed5fbff0b874da8e24add7f6cc50b65e"></a><!-- doxytag: member="ost::SocketPort::attach" ref="ed5fbff0b874da8e24add7f6cc50b65e" args="(SocketService *svc)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SocketPort::attach </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket_service.html">SocketService</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>svc</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Attach yourself to the service pool thread object.
<p>
The later version.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svc</em> </td><td>pool thread object </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a54">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="0edb8c155c97099cc0660b3ad1eef77f"></a><!-- doxytag: member="ost::SocketPort::connect" ref="0edb8c155c97099cc0660b3ad1eef77f" args="(const IPV6Address &ia, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::SocketPort::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_address.html">IPV6Address</a> & </td>
<td class="mdname" nowrap> <em>ia</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="3601785c16646b7e323cf2d267ce7481"></a><!-- doxytag: member="ost::SocketPort::connect" ref="3601785c16646b7e323cf2d267ce7481" args="(const IPV4Address &ia, tpport_t port)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::SocketPort::connect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_address.html">IPV4Address</a> & </td>
<td class="mdname" nowrap> <em>ia</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> </td>
<td class="mdname" nowrap> <em>port</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Connect a <a class="el" href="classost_1_1_socket.html">Socket</a> Port to a known peer host.
<p>
This is normally used with the UDP constructor. This is also performed as a non-blocking operation under Posix systems to prevent delays in a callback handler.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 if successful. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ia</em> </td><td>address of remote host or subnet. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>number of remote peer(s). </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="7b2a739ee0cb11bc6332010f4cd21552"></a><!-- doxytag: member="ost::SocketPort::disconnect" ref="7b2a739ee0cb11bc6332010f4cd21552" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SocketPort::disconnect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread pool when a disconnect has occured.
<p>
</td>
</tr>
</table>
<a class="anchor" name="4d09daed3fe5cb81259985db87add34d"></a><!-- doxytag: member="ost::SocketPort::expired" ref="4d09daed3fe5cb81259985db87add34d" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SocketPort::expired </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread pool when the objects timer has expired.
<p>
Used for timed events. <dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a55">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="80a16072f163a5a49341c4fd495fd9b1"></a><!-- doxytag: member="ost::SocketPort::getDetectOutput" ref="80a16072f163a5a49341c4fd495fd9b1" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::SocketPort::getDetectOutput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the current state of the DetectOutput flag.
<p>
</td>
</tr>
</table>
<a class="anchor" name="f1e65f719e39f651ad8789183f8905c9"></a><!-- doxytag: member="ost::SocketPort::getDetectPending" ref="f1e65f719e39f651ad8789183f8905c9" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::SocketPort::getDetectPending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the current state of the DetectPending flag.
<p>
</td>
</tr>
</table>
<a class="anchor" name="1a7e2bf9e250ea5dcc9e8416aecfbb13"></a><!-- doxytag: member="ost::SocketPort::incTimer" ref="1a7e2bf9e250ea5dcc9e8416aecfbb13" args="(timeout_t timeout)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SocketPort::incTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Derived incTimer to notify the service thread pool of a change in expected timeout.
<p>
This allows <a class="el" href="classost_1_1_socket_service.html">SocketService</a> to reschedule all timers. Otherwise same as <a class="el" href="classost_1_1_timer_port.html">TimerPort</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>in milliseconds. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_timer_port.html#b2c732120c3bb09e8d38a87b7443906d">ost::TimerPort</a>. </td>
</tr>
</table>
<a class="anchor" name="f333abc3b9f8f8b2ce4d286d64d54848"></a><!-- doxytag: member="ost::SocketPort::output" ref="f333abc3b9f8f8b2ce4d286d64d54848" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SocketPort::output </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread pool when output data is pending for this socket.
<p>
</td>
</tr>
</table>
<a class="anchor" name="fb7798f8cc7e50d42ad82a1537e89c63"></a><!-- doxytag: member="ost::SocketPort::peek" ref="fb7798f8cc7e50d42ad82a1537e89c63" args="(void *buf, size_t len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ssize_t ost::SocketPort::peek </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Examine the content of the next packet.
<p>
This can be used to build "smart" line buffering for derived TCP classes.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to packet buffer to examine. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of packet buffer to examine. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes actually available. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="5e0ec242cfb737db369cbc63abcc06b6"></a><!-- doxytag: member="ost::SocketPort::pending" ref="5e0ec242cfb737db369cbc63abcc06b6" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SocketPort::pending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread pool when input data is pending for this socket.
<p>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a56">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="872c38a65b17113a580af345946146d7"></a><!-- doxytag: member="ost::SocketPort::receive" ref="872c38a65b17113a580af345946146d7" args="(void *buf, size_t len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ssize_t ost::SocketPort::receive </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Receive a message from any host.
<p>
This is used in derived classes to build protocols.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to packet buffer to receive. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of packet buffer to receive. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes received. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a57">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="9218e4528f5bdf4215200e2040eefe5b"></a><!-- doxytag: member="ost::SocketPort::send" ref="9218e4528f5bdf4215200e2040eefe5b" args="(const void *buf, size_t len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ssize_t ost::SocketPort::send </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Transmit "send" data to a connected peer host.
<p>
This is not public by default since an overriding protocol is likely to be used in a derived class.<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes sent. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>address of buffer to send. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of bytes to send. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a58">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="229b32cb2bf8a306b8882413748eb44c"></a><!-- doxytag: member="ost::SocketPort::setDetectOutput" ref="229b32cb2bf8a306b8882413748eb44c" args="(bool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SocketPort::setDetectOutput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to indicate if output ready monitoring should be performed by the service thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="908891c78c95d66424cde91e52299c29"></a><!-- doxytag: member="ost::SocketPort::setDetectPending" ref="908891c78c95d66424cde91e52299c29" args="(bool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SocketPort::setDetectPending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to indicate if the service thread should monitor pending data for us.
<p>
</td>
</tr>
</table>
<a class="anchor" name="c70f9eae6b6b3625c980fa84180e8151"></a><!-- doxytag: member="ost::SocketPort::setTimer" ref="c70f9eae6b6b3625c980fa84180e8151" args="(timeout_t timeout=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SocketPort::setTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> = <code>0</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Derived setTimer to notify the service thread pool of change in expected timeout.
<p>
This allows <a class="el" href="classost_1_1_socket_service.html">SocketService</a> to reschedule all timers. Otherwise same as <a class="el" href="classost_1_1_timer_port.html">TimerPort</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>in milliseconds. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_timer_port.html#32b59a072fe60d94251a53579b3ca17f">ost::TimerPort</a>.<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a53">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="4b89563fb4861da0276ccd214f93122d"></a><!-- doxytag: member="ost::SocketPort::SocketService" ref="4b89563fb4861da0276ccd214f93122d" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">friend class <a class="el" href="classost_1_1_socket_service.html">SocketService</a><code> [friend]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="socketport_8h-source.html">socketport.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 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>
