<!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::Socket 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.html">Socket</a></div>
<h1>ost::Socket Class Reference</h1><!-- doxytag: class="ost::Socket" -->The <a class="el" href="classost_1_1_socket.html">Socket</a> is used as the base for all Internet protocol services under Common C++.base class of all sockets.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="socket_8h-source.html">socket.h</a>></code>
<p>
<p>Inheritance diagram for ost::Socket:
<p><center><img src="classost_1_1_socket.png" usemap="#ost::Socket_map" border="0" alt=""></center>
<map name="ost::Socket_map">
<area href="classost_1_1_simple_t_c_p_stream.html" alt="ost::SimpleTCPStream" shape="rect" coords="144,56,278,80">
<area href="classost_1_1_socket_port.html" alt="ost::SocketPort" shape="rect" coords="144,112,278,136">
<area href="classost_1_1_t_c_p_socket.html" alt="ost::TCPSocket" shape="rect" coords="144,168,278,192">
<area href="classost_1_1_t_c_p_stream.html" alt="ost::TCPStream" shape="rect" coords="144,224,278,248">
<area href="classost_1_1_t_c_p_v6_socket.html" alt="ost::TCPV6Socket" shape="rect" coords="144,280,278,304">
<area href="classost_1_1_u_d_p_socket.html" alt="ost::UDPSocket" shape="rect" coords="144,336,278,360">
<area href="classost_1_1_unix_socket.html" alt="ost::UnixSocket" shape="rect" coords="144,392,278,416">
<area href="classost_1_1_unix_stream.html" alt="ost::UnixStream" shape="rect" coords="144,448,278,472">
</map>
<a href="classost_1_1_socket-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <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.html#3306a277326459f69aa69b474f50d6e2">Error</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">Tos</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">Tos</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#36a69681caa020f1abed34ae71d206ef">Family</a> { <a class="el" href="classost_1_1_socket.html#36a69681caa020f1abed34ae71d206efe49b01941932c262f6fbbc8e21d3340d">IPV6</a> = AF_INET6,
<a class="el" href="classost_1_1_socket.html#36a69681caa020f1abed34ae71d206ef5bd9a46a5c0f46815c98feeb02e5e926">IPV4</a> = AF_INET
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f">Error</a> { <br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f706ac48f0deba4e591d9668ea79962e8">errSuccess</a> = 0,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f8d1d01d77a141c804b50456d70b94e46">errCreateFailed</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f394bc212b3ab9c69dcb47b1412cedb53">errCopyFailed</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3fa5b3fc41be74d485b9aca2af43d27424">errInput</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3fc1c33a97e722515f9851b116dc7bf2c5">errInputInterrupt</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f5833cd0e1a43ae7d420e62ce0851611e">errResourceFailure</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f1c7ee1231e7e7f8e8b6b1447d6f15090">errOutput</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3ff67d1bcf85481bc4dd222f91e92deeb4">errOutputInterrupt</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f672dcab0341a211dcb14e0f848e9b5f9">errNotConnected</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3fde54564fcb05a1744ccbf94f5a1b57a5">errConnectRefused</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f837e20c1c3c6cf12d670f87afc1e8f66">errConnectRejected</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3ff1a03fa32f971b5077ebf1cf749e90fa">errConnectTimeout</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f7646955354dce1249d606a2369ea6eaa">errConnectFailed</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f1629a51edc39b379b3736a07d07bd782">errConnectInvalid</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3fd21ca357b1645094f6ddcbac26a4deed">errConnectBusy</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f42e56e9bcd983284be704de1400d991d">errConnectNoRoute</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f61d62014cda69b8d77dd07141f59252b">errBindingFailed</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3fc3609d1255c9a57b86edc1c9a9a79e42">errBroadcastDenied</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3fa352506dcb7b1d118837c1808944466f">errRoutingDenied</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f4e60741a75df84410263a3113090f55a">errKeepaliveDenied</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f6a5e613ed6f8b222d924e419943a870c">errServiceDenied</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f4739d2c04636eff1971b3648bda5f672">errServiceUnavailable</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f8753eb8cc4591d5288c72ba2c91ea956">errMulticastDisabled</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f5d0c869dc200b3cd1eab866816dc217a">errTimeout</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3ffe1fd02e79a208ee781a5b41f7fb5814">errNoDelay</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f8f699326e6567ea4171d5821fa417e35">errExtended</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f337bdb7f7512963ef0354f8be541c71e">errLookupFail</a>,
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f8939131de2df58fc2327933cbd024e49">errSearchErr</a>,
<br>
<a class="el" href="classost_1_1_socket.html#e056b6dd4f167163083b7ab602fd3f3f9ede2afac3c4df2fd5671d48cbf546dc">errInvalidValue</a>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#258f81f5a42d051242f0f49f8192f890">Tos</a> { <br>
<a class="el" href="classost_1_1_socket.html#258f81f5a42d051242f0f49f8192f8902199fbf8a1e891120f27a67559e9b6ff">tosLowDelay</a> = 0,
<a class="el" href="classost_1_1_socket.html#258f81f5a42d051242f0f49f8192f890e805c8e2bc547dbc94b32ccc19c1396b">tosThroughput</a>,
<a class="el" href="classost_1_1_socket.html#258f81f5a42d051242f0f49f8192f890d0e7d077cb9c6e6f3e702bc735af87d4">tosReliability</a>,
<a class="el" href="classost_1_1_socket.html#258f81f5a42d051242f0f49f8192f890ed0323ec6ea800b824853441c4ccd3e8">tosMinCost</a>,
<br>
<a class="el" href="classost_1_1_socket.html#258f81f5a42d051242f0f49f8192f890c0b92a366fed8d304b3c91323aa49a15">tosInvalid</a>
<br>
}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> { <a class="el" href="classost_1_1_socket.html#2cb9ccad21fc2f10c23e45cbb99bc6f8f2d41647f208c78eb97fe77196c55ccc">pendingInput</a>,
<a class="el" href="classost_1_1_socket.html#2cb9ccad21fc2f10c23e45cbb99bc6f80c9ffb2c87eb616774ea812fc9739efd">pendingOutput</a>,
<a class="el" href="classost_1_1_socket.html#2cb9ccad21fc2f10c23e45cbb99bc6f8d3bac41d6ea72956235766139b8742d6">pendingError</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></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.html#801b3892635919626d7fc8f3d03da933">~Socket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object. <a href="#801b3892635919626d7fc8f3d03da933"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html">Socket</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#b0d02dbca94775d6b28c9d313b55fdcc">operator=</a> (const <a class="el" href="classost_1_1_socket.html">Socket</a> &from)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sockets may also be duplicated by the assignment operator. <a href="#b0d02dbca94775d6b28c9d313b55fdcc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#7853e912f214a1f6fd05b1335f460f35">getIPV4Sender</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">May be used to examine the origin of data waiting in the socket receive queue. <a href="#7853e912f214a1f6fd05b1335f460f35"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#99197c017c07c6b24d622b107fa46833">getSender</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#3e4afdfd4efa11d9898558fe852c4230">getIPV6Sender</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#8c8d2cfd48c75b03dc776b38b1c095f7">getIPV4Peer</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the host address and port of the socket this socket is connected to. <a href="#8c8d2cfd48c75b03dc776b38b1c095f7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#6fd1dffdfe9606e56fba838559ff6d67">getPeer</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#d625daf4cffb541c5e8592792d4ee77e">getIPV6Peer</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#f72396adf4cac5113e722447e48b7916">getIPV4Local</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the local address and port number this socket is currently bound to. <a href="#f72396adf4cac5113e722447e48b7916"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ca71d871bfda4dfcab0891cb0c8df1d4">getLocal</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#8410324ca8ddf50751830f59afeaf377">getIPV6Local</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#27574c4f148166ef8857975ba3cbb5a5">getIPV4NAT</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform NAT table lookup for this socket. <a href="#27574c4f148166ef8857975ba3cbb5a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#c3dded47080c852dcebc9998643e8dc6">getNAT</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#6af9d4d0da053afae46cf26c58c952cc">getIPV6NAT</a> (<a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </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.html#16eb72794ce956b2af6b935eb59b2e24">setCompletion</a> (bool immediate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to specify blocking mode for the socket. <a href="#16eb72794ce956b2af6b935eb59b2e24"></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.html#8a7b1c8f4735ffb2c8e7248e4bf37ef3">setLinger</a> (bool <a class="el" href="classost_1_1_socket.html#617e01f010e15ec81be466052a5a378e">linger</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable lingering sockets on close. <a href="#8a7b1c8f4735ffb2c8e7248e4bf37ef3"></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.html#866263b2933c0b7b649829f07ca288ff">setKeepAlive</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the keep-alive status of this socket and if keep-alive messages will be sent. <a href="#866263b2933c0b7b649829f07ca288ff"></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.html#e49df7e3c3913147116d8491f77a1b63">setTypeOfService</a> (<a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">Tos</a> service)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set packet scheduling on platforms which support ip quality of service conventions. <a href="#e49df7e3c3913147116d8491f77a1b63"></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.html#2997c1ed398ce1c6dbf1eb62301f97cc">isConnected</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Can test to see if this socket is "connected", and hence whether a "catch" can safely call <a class="el" href="classost_1_1_socket.html#6fd1dffdfe9606e56fba838559ff6d67">getPeer()</a>. <a href="#2997c1ed398ce1c6dbf1eb62301f97cc"></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.html#114e5d4cad99aaff24718b05bd3e8e31">isActive</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test to see if the socket is at least operating or if it is mearly initialized. <a href="#114e5d4cad99aaff24718b05bd3e8e31"></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.html#5e2c05b34bded0db1bcdcf08bd44f052">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator based testing to see if a socket is currently active. <a href="#5e2c05b34bded0db1bcdcf08bd44f052"></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.html#8120ca95daa7c488255c308998427ccb">isBroadcast</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return if broadcast has been enabled for the specified socket. <a href="#8120ca95daa7c488255c308998427ccb"></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.html#0a1e09a4411bf60bb5e2b6235d4e6a46">isRouted</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return if socket routing is enabled. <a href="#0a1e09a4411bf60bb5e2b6235d4e6a46"></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.html#bfdaefd24888f2d51089bdb31894286e">getErrorNumber</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Often used by a "catch" to fetch the last error of a thrown socket. <a href="#bfdaefd24888f2d51089bdb31894286e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#d1c8bb17f75cfe540853a871081bd9d0">getErrorString</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used. <a href="#d1c8bb17f75cfe540853a871081bd9d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#7720aace2bf055d21a6fc33007c88197">getSystemError</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#69b34d0fdbb94b77df4647cdb8b98407">getSystemErrorString</a> (void) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#8eb84be4b5cc91731c16be4f32f5bf3d">isPending</a> (<a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a> pend, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of pending operations. <a href="#8eb84be4b5cc91731c16be4f32f5bf3d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#f735f45763298ad70b9925518b795837">check</a> (<a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> fam)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See if a specific protocol family is available in the current runtime environment. <a href="#f735f45763298ad70b9925518b795837"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">State</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe55571066">State</a> { <br>
<a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe55571066bd827e310a97ea890353a7ee5f92885c">INITIAL</a>,
<a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe555710669181006b79c1fc5111fa9fd8adced04d">AVAILABLE</a>,
<a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe555710666f74458d0045b716df163290d56a5c85">BOUND</a>,
<a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe55571066421a6e01dfd1841341d0dbcd7e821aa6">CONNECTED</a>,
<br>
<a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe555710668240e96a84fba05c787ee8f770bbc47d">CONNECTING</a>,
<a class="el" href="classost_1_1_socket.html#d17e0a386f4c50a57db3bebe55571066f623db6499fd0e2eca13da3c94048fd0">STREAM</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"><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.html#02525cefdf512d6cbf058854c9c27968">error</a> (<a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> error, char *err=NULL, long systemError=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This service is used to throw all socket errors which usually occur during the socket constructor. <a href="#02525cefdf512d6cbf058854c9c27968"></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.html#ffe0b3cfd0ff7a2511e91a81a590fe66">error</a> (char *err) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This service is used to throw application defined socket errors where the application specific error code is a string. <a href="#ffe0b3cfd0ff7a2511e91a81a590fe66"></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.html#6f54a68eab25ab41bbe13ba87a48b435">setError</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. <a href="#6f54a68eab25ab41bbe13ba87a48b435"></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.html#3ab340e773f0214eefcf66f588bcf174">endSocket</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used as the default destructor for ending a socket. <a href="#3ab340e773f0214eefcf66f588bcf174"></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.html#217dc5ca83ea9fe3849bc34b6ee5253d">connectError</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used as a common handler for connection failure processing. <a href="#217dc5ca83ea9fe3849bc34b6ee5253d"></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.html#101d527767089e3df6d8cbff84829791">sendLimit</a> (int limit=2048)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the send limit. <a href="#101d527767089e3df6d8cbff84829791"></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.html#e9b26fb7d8253c5507d9d1b92bd50742">receiveLimit</a> (int limit=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set thr receive limit. <a href="#e9b26fb7d8253c5507d9d1b92bd50742"></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.html#e7db59127b8297729d668d4eeed8ccab">sendTimeout</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the send timeout for sending raw network data. <a href="#e7db59127b8297729d668d4eeed8ccab"></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.html#20b144ed2110e3b1c597875aa44be6df">receiveTimeout</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive timeout for receiving raw network data. <a href="#20b144ed2110e3b1c597875aa44be6df"></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.html#20ad4739d705c429a9eb5388e4a3bccf">sendBuffer</a> (unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the protocol stack network kernel send buffer size associated with the socket. <a href="#20ad4739d705c429a9eb5388e4a3bccf"></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.html#e3bd5146ee9b4b5dbc0da8bbbc8457ce">receiveBuffer</a> (unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the protocol stack network kernel receive buffer size associated with the socket. <a href="#e3bd5146ee9b4b5dbc0da8bbbc8457ce"></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.html#dbc655480acedfcc5febdd28631f0fa7">bufferSize</a> (unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the total protocol stack network kernel buffer size for both send and receive together. <a href="#dbc655480acedfcc5febdd28631f0fa7"></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.html#1a507041ee5741bcdc906707b1735781">setBroadcast</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the subnet broadcast flag for the socket. <a href="#1a507041ee5741bcdc906707b1735781"></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.html#09b396c3fc7316061a3f0539e918a43f">setMulticastByFamily</a> (bool enable, <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> family=IPV4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. <a href="#09b396c3fc7316061a3f0539e918a43f"></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.html#08683bc57bede572b8effb07a3fc68dc">setLoopbackByFamily</a> (bool enable, <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> family=IPV4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the multicast loopback flag for the socket. <a href="#08683bc57bede572b8effb07a3fc68dc"></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.html#23d69227150ae996caf76b01024c1b20">setTimeToLiveByFamily</a> (unsigned char <a class="el" href="classost_1_1_socket.html#6adc7a5d594ab3b8bace496f7a6757e9">ttl</a>, <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> fam=IPV4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the multicast time to live for a multicast socket. <a href="#23d69227150ae996caf76b01024c1b20"></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.html#fb0e2d234f461ce45711bff52ffc96ad">join</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join a multicast group. <a href="#fb0e2d234f461ce45711bff52ffc96ad"></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.html#b7d4e7cfd0411833ab0b02db1dbed8d5">join</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</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.html#c59c08e11070a1602352da5c54332d9e">drop</a> (const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> &ia)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drop membership from a multicast group. <a href="#c59c08e11070a1602352da5c54332d9e"></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.html#54bb968bfe110dc65bd5d0fb4a47383d">drop</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</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.html#2165fdf85e39e6a8aaff3da889ae7e20">setRouting</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). <a href="#2165fdf85e39e6a8aaff3da889ae7e20"></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.html#a2c47291cf56762847cf82edfc63e473">setNoDelay</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable delaying packets (Nagle algorithm). <a href="#a2c47291cf56762847cf82edfc63e473"></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.html#80235ff77955cff4f3b44dfcd4546939">Socket</a> (int domain, int type, int protocol=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An unconnected socket may be created directly on the local machine. <a href="#80235ff77955cff4f3b44dfcd4546939"></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.html#b626d95fcde74c4e1f1ba1da49b941fb">Socket</a> (<a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> fd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call. <a href="#b626d95fcde74c4e1f1ba1da49b941fb"></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.html#eda9b71324d761b3e6ac45c25613d048">Socket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an inactive socket object for base constructors. <a href="#eda9b71324d761b3e6ac45c25613d048"></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.html#cc82106055495c1b464755807b622689">Socket</a> (const <a class="el" href="classost_1_1_socket.html">Socket</a> &source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A socket can also be constructed from an already existing <a class="el" href="classost_1_1_socket.html">Socket</a> object. <a href="#cc82106055495c1b464755807b622689"></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.html#74e77522b18ff7f10774c2fd333b99c3">readLine</a> (char *buf, size_t len, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_process.html">Process</a> a logical input line from a socket descriptor directly. <a href="#74e77522b18ff7f10774c2fd333b99c3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#344ae2c256e388447f198288d2d0b41d">readData</a> (void *buf, size_t len, char separator=0, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read in a block of len bytes with specific separator. <a href="#344ae2c256e388447f198288d2d0b41d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#e81f041407f05517bc1a8b30896965f3">writeData</a> (const void *buf, size_t len, <a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a block of len bytes to socket. <a href="#e81f041407f05517bc1a8b30896965f3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap>struct {</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#9ade0c61ad6d9b0d27c71497b6e68bd5">thrown</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#2b6b25a155d401b661d62eef57754bfa">broadcast</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#118af6ea8eba44a8dbe687f2d31a9022">route</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#507d2a060e03c63bbdf0599ffa9d555a">keepalive</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#19604a7ca524f3ee4c7623c7c237ff69">loopback</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#85db9df29af07929253387d76c59ab2b">multicast</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#f1ef1afa83f77869dc56910ff289d0c5">completion</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> bool <a class="el" href="classost_1_1_socket.html#617e01f010e15ec81be466052a5a378e">linger</a>: 1</td></tr>
<tr><td class="memItemLeft" nowrap> unsigned <a class="el" href="classost_1_1_socket.html#6adc7a5d594ab3b8bace496f7a6757e9">ttl</a>: 8</td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#16622c150177604c25b58072f1985225">flags</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> volatile </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#f1291caf47c2e2e72a3214e4da206b07">so</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the actual socket descriptor, in Windows, unlike posix it *cannot* be used as an file descriptor that way madness lies -- jfc <a href="#f1291caf47c2e2e72a3214e4da206b07"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">State</a> volatile </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#72526c7c326a7faa20e96e9be01981ba">state</a></td></tr>
<tr><td colspan="2"><br><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classost_1_1_mutex.html">Mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#795099d3d68f4c3bf7731f263cbd1ace">mutex</a></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#15cb7666fe8982dc64e01354ac48dac4">dupSocket</a> (<a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> s, <a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">Socket::State</a> <a class="el" href="classost_1_1_socket.html#72526c7c326a7faa20e96e9be01981ba">state</a>)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classost_1_1_socket.html">Socket</a> is used as the base for all Internet protocol services under Common C++.base class of all sockets.
<p>
A socket is a system resource (or winsock descriptor) that occupies a specific port address (and may be bound to a specific network interface) on the local machine. The socket may also be directly connected to a specific socket on a remote internet host.<p>
This base class is not directly used, but is provided to offer properties common to other Common C++ socket classes, including the socket exception model and the ability to set socket properties such as QoS, "sockopts" properties like Dont-Route and Keep-Alive, etc.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="3306a277326459f69aa69b474f50d6e2"></a><!-- doxytag: member="ost::Socket::Error" ref="3306a277326459f69aa69b474f50d6e2" 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">typedef enum <a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> <a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">ost::Socket::Error</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#3cbe53f1c34d7fdbd73efa61edbf463d">ost::URLStream</a>. </td>
</tr>
</table>
<a class="anchor" name="aa032e41b920b38a79c875b8ae375799"></a><!-- doxytag: member="ost::Socket::Family" ref="aa032e41b920b38a79c875b8ae375799" 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">typedef enum <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">ost::Socket::Family</a> </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="c2fe3b8bf4dfc66c7df11dfa1ce4415c"></a><!-- doxytag: member="ost::Socket::Pending" ref="c2fe3b8bf4dfc66c7df11dfa1ce4415c" 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">typedef enum <a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a> <a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">ost::Socket::Pending</a> </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="c8890572886dca1a03a775997f04abba"></a><!-- doxytag: member="ost::Socket::State" ref="c8890572886dca1a03a775997f04abba" 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">typedef enum <a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">State</a> <a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">ost::Socket::State</a><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="7caa0e1bb24b387bd1c5b8240ea592e1"></a><!-- doxytag: member="ost::Socket::Tos" ref="7caa0e1bb24b387bd1c5b8240ea592e1" 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">typedef enum <a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">Tos</a> <a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">ost::Socket::Tos</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f"></a><!-- doxytag: member="ost::Socket::Error" ref="e056b6dd4f167163083b7ab602fd3f3f" 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">enum <a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">ost::Socket::Error</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f706ac48f0deba4e591d9668ea79962e8"></a><!-- doxytag: member="errSuccess" ref="e056b6dd4f167163083b7ab602fd3f3f706ac48f0deba4e591d9668ea79962e8" args="" -->errSuccess</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f8d1d01d77a141c804b50456d70b94e46"></a><!-- doxytag: member="errCreateFailed" ref="e056b6dd4f167163083b7ab602fd3f3f8d1d01d77a141c804b50456d70b94e46" args="" -->errCreateFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f394bc212b3ab9c69dcb47b1412cedb53"></a><!-- doxytag: member="errCopyFailed" ref="e056b6dd4f167163083b7ab602fd3f3f394bc212b3ab9c69dcb47b1412cedb53" args="" -->errCopyFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3fa5b3fc41be74d485b9aca2af43d27424"></a><!-- doxytag: member="errInput" ref="e056b6dd4f167163083b7ab602fd3f3fa5b3fc41be74d485b9aca2af43d27424" args="" -->errInput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3fc1c33a97e722515f9851b116dc7bf2c5"></a><!-- doxytag: member="errInputInterrupt" ref="e056b6dd4f167163083b7ab602fd3f3fc1c33a97e722515f9851b116dc7bf2c5" args="" -->errInputInterrupt</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f5833cd0e1a43ae7d420e62ce0851611e"></a><!-- doxytag: member="errResourceFailure" ref="e056b6dd4f167163083b7ab602fd3f3f5833cd0e1a43ae7d420e62ce0851611e" args="" -->errResourceFailure</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f1c7ee1231e7e7f8e8b6b1447d6f15090"></a><!-- doxytag: member="errOutput" ref="e056b6dd4f167163083b7ab602fd3f3f1c7ee1231e7e7f8e8b6b1447d6f15090" args="" -->errOutput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3ff67d1bcf85481bc4dd222f91e92deeb4"></a><!-- doxytag: member="errOutputInterrupt" ref="e056b6dd4f167163083b7ab602fd3f3ff67d1bcf85481bc4dd222f91e92deeb4" args="" -->errOutputInterrupt</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f672dcab0341a211dcb14e0f848e9b5f9"></a><!-- doxytag: member="errNotConnected" ref="e056b6dd4f167163083b7ab602fd3f3f672dcab0341a211dcb14e0f848e9b5f9" args="" -->errNotConnected</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3fde54564fcb05a1744ccbf94f5a1b57a5"></a><!-- doxytag: member="errConnectRefused" ref="e056b6dd4f167163083b7ab602fd3f3fde54564fcb05a1744ccbf94f5a1b57a5" args="" -->errConnectRefused</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f837e20c1c3c6cf12d670f87afc1e8f66"></a><!-- doxytag: member="errConnectRejected" ref="e056b6dd4f167163083b7ab602fd3f3f837e20c1c3c6cf12d670f87afc1e8f66" args="" -->errConnectRejected</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3ff1a03fa32f971b5077ebf1cf749e90fa"></a><!-- doxytag: member="errConnectTimeout" ref="e056b6dd4f167163083b7ab602fd3f3ff1a03fa32f971b5077ebf1cf749e90fa" args="" -->errConnectTimeout</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f7646955354dce1249d606a2369ea6eaa"></a><!-- doxytag: member="errConnectFailed" ref="e056b6dd4f167163083b7ab602fd3f3f7646955354dce1249d606a2369ea6eaa" args="" -->errConnectFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f1629a51edc39b379b3736a07d07bd782"></a><!-- doxytag: member="errConnectInvalid" ref="e056b6dd4f167163083b7ab602fd3f3f1629a51edc39b379b3736a07d07bd782" args="" -->errConnectInvalid</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3fd21ca357b1645094f6ddcbac26a4deed"></a><!-- doxytag: member="errConnectBusy" ref="e056b6dd4f167163083b7ab602fd3f3fd21ca357b1645094f6ddcbac26a4deed" args="" -->errConnectBusy</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f42e56e9bcd983284be704de1400d991d"></a><!-- doxytag: member="errConnectNoRoute" ref="e056b6dd4f167163083b7ab602fd3f3f42e56e9bcd983284be704de1400d991d" args="" -->errConnectNoRoute</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f61d62014cda69b8d77dd07141f59252b"></a><!-- doxytag: member="errBindingFailed" ref="e056b6dd4f167163083b7ab602fd3f3f61d62014cda69b8d77dd07141f59252b" args="" -->errBindingFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3fc3609d1255c9a57b86edc1c9a9a79e42"></a><!-- doxytag: member="errBroadcastDenied" ref="e056b6dd4f167163083b7ab602fd3f3fc3609d1255c9a57b86edc1c9a9a79e42" args="" -->errBroadcastDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3fa352506dcb7b1d118837c1808944466f"></a><!-- doxytag: member="errRoutingDenied" ref="e056b6dd4f167163083b7ab602fd3f3fa352506dcb7b1d118837c1808944466f" args="" -->errRoutingDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f4e60741a75df84410263a3113090f55a"></a><!-- doxytag: member="errKeepaliveDenied" ref="e056b6dd4f167163083b7ab602fd3f3f4e60741a75df84410263a3113090f55a" args="" -->errKeepaliveDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f6a5e613ed6f8b222d924e419943a870c"></a><!-- doxytag: member="errServiceDenied" ref="e056b6dd4f167163083b7ab602fd3f3f6a5e613ed6f8b222d924e419943a870c" args="" -->errServiceDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f4739d2c04636eff1971b3648bda5f672"></a><!-- doxytag: member="errServiceUnavailable" ref="e056b6dd4f167163083b7ab602fd3f3f4739d2c04636eff1971b3648bda5f672" args="" -->errServiceUnavailable</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f8753eb8cc4591d5288c72ba2c91ea956"></a><!-- doxytag: member="errMulticastDisabled" ref="e056b6dd4f167163083b7ab602fd3f3f8753eb8cc4591d5288c72ba2c91ea956" args="" -->errMulticastDisabled</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f5d0c869dc200b3cd1eab866816dc217a"></a><!-- doxytag: member="errTimeout" ref="e056b6dd4f167163083b7ab602fd3f3f5d0c869dc200b3cd1eab866816dc217a" args="" -->errTimeout</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3ffe1fd02e79a208ee781a5b41f7fb5814"></a><!-- doxytag: member="errNoDelay" ref="e056b6dd4f167163083b7ab602fd3f3ffe1fd02e79a208ee781a5b41f7fb5814" args="" -->errNoDelay</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f8f699326e6567ea4171d5821fa417e35"></a><!-- doxytag: member="errExtended" ref="e056b6dd4f167163083b7ab602fd3f3f8f699326e6567ea4171d5821fa417e35" args="" -->errExtended</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f337bdb7f7512963ef0354f8be541c71e"></a><!-- doxytag: member="errLookupFail" ref="e056b6dd4f167163083b7ab602fd3f3f337bdb7f7512963ef0354f8be541c71e" args="" -->errLookupFail</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f8939131de2df58fc2327933cbd024e49"></a><!-- doxytag: member="errSearchErr" ref="e056b6dd4f167163083b7ab602fd3f3f8939131de2df58fc2327933cbd024e49" args="" -->errSearchErr</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="e056b6dd4f167163083b7ab602fd3f3f9ede2afac3c4df2fd5671d48cbf546dc"></a><!-- doxytag: member="errInvalidValue" ref="e056b6dd4f167163083b7ab602fd3f3f9ede2afac3c4df2fd5671d48cbf546dc" args="" -->errInvalidValue</em> </td><td>
</td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#3cbe53f1c34d7fdbd73efa61edbf463d">ost::URLStream</a>. </td>
</tr>
</table>
<a class="anchor" name="36a69681caa020f1abed34ae71d206ef"></a><!-- doxytag: member="ost::Socket::Family" ref="36a69681caa020f1abed34ae71d206ef" 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">enum <a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">ost::Socket::Family</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="36a69681caa020f1abed34ae71d206efe49b01941932c262f6fbbc8e21d3340d"></a><!-- doxytag: member="IPV6" ref="36a69681caa020f1abed34ae71d206efe49b01941932c262f6fbbc8e21d3340d" args="" -->IPV6</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="36a69681caa020f1abed34ae71d206ef5bd9a46a5c0f46815c98feeb02e5e926"></a><!-- doxytag: member="IPV4" ref="36a69681caa020f1abed34ae71d206ef5bd9a46a5c0f46815c98feeb02e5e926" args="" -->IPV4</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="2cb9ccad21fc2f10c23e45cbb99bc6f8"></a><!-- doxytag: member="ost::Socket::Pending" ref="2cb9ccad21fc2f10c23e45cbb99bc6f8" 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">enum <a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">ost::Socket::Pending</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="2cb9ccad21fc2f10c23e45cbb99bc6f8f2d41647f208c78eb97fe77196c55ccc"></a><!-- doxytag: member="pendingInput" ref="2cb9ccad21fc2f10c23e45cbb99bc6f8f2d41647f208c78eb97fe77196c55ccc" args="" -->pendingInput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="2cb9ccad21fc2f10c23e45cbb99bc6f80c9ffb2c87eb616774ea812fc9739efd"></a><!-- doxytag: member="pendingOutput" ref="2cb9ccad21fc2f10c23e45cbb99bc6f80c9ffb2c87eb616774ea812fc9739efd" args="" -->pendingOutput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="2cb9ccad21fc2f10c23e45cbb99bc6f8d3bac41d6ea72956235766139b8742d6"></a><!-- doxytag: member="pendingError" ref="2cb9ccad21fc2f10c23e45cbb99bc6f8d3bac41d6ea72956235766139b8742d6" args="" -->pendingError</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d17e0a386f4c50a57db3bebe55571066"></a><!-- doxytag: member="ost::Socket::State" ref="d17e0a386f4c50a57db3bebe55571066" 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">enum <a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">ost::Socket::State</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="d17e0a386f4c50a57db3bebe55571066bd827e310a97ea890353a7ee5f92885c"></a><!-- doxytag: member="INITIAL" ref="d17e0a386f4c50a57db3bebe55571066bd827e310a97ea890353a7ee5f92885c" args="" -->INITIAL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d17e0a386f4c50a57db3bebe555710669181006b79c1fc5111fa9fd8adced04d"></a><!-- doxytag: member="AVAILABLE" ref="d17e0a386f4c50a57db3bebe555710669181006b79c1fc5111fa9fd8adced04d" args="" -->AVAILABLE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d17e0a386f4c50a57db3bebe555710666f74458d0045b716df163290d56a5c85"></a><!-- doxytag: member="BOUND" ref="d17e0a386f4c50a57db3bebe555710666f74458d0045b716df163290d56a5c85" args="" -->BOUND</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d17e0a386f4c50a57db3bebe55571066421a6e01dfd1841341d0dbcd7e821aa6"></a><!-- doxytag: member="CONNECTED" ref="d17e0a386f4c50a57db3bebe55571066421a6e01dfd1841341d0dbcd7e821aa6" args="" -->CONNECTED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d17e0a386f4c50a57db3bebe555710668240e96a84fba05c787ee8f770bbc47d"></a><!-- doxytag: member="CONNECTING" ref="d17e0a386f4c50a57db3bebe555710668240e96a84fba05c787ee8f770bbc47d" args="" -->CONNECTING</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d17e0a386f4c50a57db3bebe55571066f623db6499fd0e2eca13da3c94048fd0"></a><!-- doxytag: member="STREAM" ref="d17e0a386f4c50a57db3bebe55571066f623db6499fd0e2eca13da3c94048fd0" args="" -->STREAM</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="258f81f5a42d051242f0f49f8192f890"></a><!-- doxytag: member="ost::Socket::Tos" ref="258f81f5a42d051242f0f49f8192f890" 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">enum <a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">ost::Socket::Tos</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="258f81f5a42d051242f0f49f8192f8902199fbf8a1e891120f27a67559e9b6ff"></a><!-- doxytag: member="tosLowDelay" ref="258f81f5a42d051242f0f49f8192f8902199fbf8a1e891120f27a67559e9b6ff" args="" -->tosLowDelay</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="258f81f5a42d051242f0f49f8192f890e805c8e2bc547dbc94b32ccc19c1396b"></a><!-- doxytag: member="tosThroughput" ref="258f81f5a42d051242f0f49f8192f890e805c8e2bc547dbc94b32ccc19c1396b" args="" -->tosThroughput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="258f81f5a42d051242f0f49f8192f890d0e7d077cb9c6e6f3e702bc735af87d4"></a><!-- doxytag: member="tosReliability" ref="258f81f5a42d051242f0f49f8192f890d0e7d077cb9c6e6f3e702bc735af87d4" args="" -->tosReliability</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="258f81f5a42d051242f0f49f8192f890ed0323ec6ea800b824853441c4ccd3e8"></a><!-- doxytag: member="tosMinCost" ref="258f81f5a42d051242f0f49f8192f890ed0323ec6ea800b824853441c4ccd3e8" args="" -->tosMinCost</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="258f81f5a42d051242f0f49f8192f890c0b92a366fed8d304b3c91323aa49a15"></a><!-- doxytag: member="tosInvalid" ref="258f81f5a42d051242f0f49f8192f890c0b92a366fed8d304b3c91323aa49a15" args="" -->tosInvalid</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="80235ff77955cff4f3b44dfcd4546939"></a><!-- doxytag: member="ost::Socket::Socket" ref="80235ff77955cff4f3b44dfcd4546939" args="(int domain, int type, int protocol=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">ost::Socket::Socket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>domain</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>type</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>protocol</em> = <code>0</code></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>
An unconnected socket may be created directly on the local machine.
<p>
Sockets can occupy both the internet domain (AF_INET) and UNIX socket domain (AF_UNIX) under unix. The socket type (SOCK_STREAM, SOCK_DGRAM) and protocol may also be specified. If the socket cannot be created, an exception is thrown.<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>domain</em> </td><td>socket domain to use. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>base type and protocol family of the socket. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>protocol</em> </td><td>specific protocol to apply. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="b626d95fcde74c4e1f1ba1da49b941fb"></a><!-- doxytag: member="ost::Socket::Socket" ref="b626d95fcde74c4e1f1ba1da49b941fb" args="(SOCKET fd)" --><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::Socket::Socket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> </td>
<td class="mdname1" valign="top" nowrap> <em>fd</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>
A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call.
<p>
This constructor is mostly for internal use.<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>fd</em> </td><td>file descriptor of an already existing socket. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="eda9b71324d761b3e6ac45c25613d048"></a><!-- doxytag: member="ost::Socket::Socket" ref="eda9b71324d761b3e6ac45c25613d048" 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">ost::Socket::Socket </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create an inactive socket object for base constructors.
<p>
</td>
</tr>
</table>
<a class="anchor" name="cc82106055495c1b464755807b622689"></a><!-- doxytag: member="ost::Socket::Socket" ref="cc82106055495c1b464755807b622689" args="(const Socket &source)" --><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::Socket::Socket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_socket.html">Socket</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>source</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>
A socket can also be constructed from an already existing <a class="el" href="classost_1_1_socket.html">Socket</a> object.
<p>
On POSIX systems, the socket file descriptor is dup()'d. On Win32, DuplicateHandle() is used.<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>source</em> </td><td>of existing socket to clone. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="801b3892635919626d7fc8f3d03da933"></a><!-- doxytag: member="ost::Socket::~Socket" ref="801b3892635919626d7fc8f3d03da933" 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::Socket::~Socket </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object.
<p>
By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dbc655480acedfcc5febdd28631f0fa7"></a><!-- doxytag: member="ost::Socket::bufferSize" ref="dbc655480acedfcc5febdd28631f0fa7" args="(unsigned size)" --><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::Socket::bufferSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned </td>
<td class="mdname1" valign="top" nowrap> <em>size</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>
Set the total protocol stack network kernel buffer size for both send and receive together.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>errSuccess on success </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>size</em> </td><td>of buffer. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="f735f45763298ad70b9925518b795837"></a><!-- doxytag: member="ost::Socket::check" ref="f735f45763298ad70b9925518b795837" args="(Family fam)" --><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">static bool ost::Socket::check </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td>
<td class="mdname1" valign="top" nowrap> <em>fam</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
See if a specific protocol family is available in the current runtime environment.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if family available. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="217dc5ca83ea9fe3849bc34b6ee5253d"></a><!-- doxytag: member="ost::Socket::connectError" ref="217dc5ca83ea9fe3849bc34b6ee5253d" 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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::Socket::connectError </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used as a common handler for connection failure processing.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>correct failure code to apply. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="54bb968bfe110dc65bd5d0fb4a47383d"></a><!-- doxytag: member="ost::Socket::drop" ref="54bb968bfe110dc65bd5d0fb4a47383d" args="(const IPV6Multicast &ia)" --><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::Socket::drop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</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>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#4fb379f4df763e3726c8097d65d4c584">ost::UDPReceive</a>. </td>
</tr>
</table>
<a class="anchor" name="c59c08e11070a1602352da5c54332d9e"></a><!-- doxytag: member="ost::Socket::drop" ref="c59c08e11070a1602352da5c54332d9e" args="(const IPV4Multicast &ia)" --><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::Socket::drop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</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>
Drop membership from a multicast group.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </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 multicast group to drop. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#6ec872d42da02ac13e3390f4ec6cb98d">ost::UDPReceive</a>. </td>
</tr>
</table>
<a class="anchor" name="3ab340e773f0214eefcf66f588bcf174"></a><!-- doxytag: member="ost::Socket::endSocket" ref="3ab340e773f0214eefcf66f588bcf174" 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">void ost::Socket::endSocket </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used as the default destructor for ending a socket.
<p>
This will cleanly terminate the socket connection. It is provided for use in derived virtual destructors. </td>
</tr>
</table>
<a class="anchor" name="ffe0b3cfd0ff7a2511e91a81a590fe66"></a><!-- doxytag: member="ost::Socket::error" ref="ffe0b3cfd0ff7a2511e91a81a590fe66" args="(char *err) 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">void ost::Socket::error </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </td>
<td class="mdname1" valign="top" nowrap> <em>err</em> </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>
This service is used to throw application defined socket errors where the application specific error code is a string.
<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>err</em> </td><td>string or message to pass. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="02525cefdf512d6cbf058854c9c27968"></a><!-- doxytag: member="ost::Socket::error" ref="02525cefdf512d6cbf058854c9c27968" args="(Error error, char *err=NULL, long systemError=0) 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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::Socket::error </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> </td>
<td class="mdname" nowrap> <em>error</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char * </td>
<td class="mdname" nowrap> <em>err</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>long </td>
<td class="mdname" nowrap> <em>systemError</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This service is used to throw all socket errors which usually occur during the socket constructor.
<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>error</em> </td><td>defined socket error id. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>err</em> </td><td>string or message to pass. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>systemError</em> </td><td>the system error# that caused the error </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="bfdaefd24888f2d51089bdb31894286e"></a><!-- doxytag: member="ost::Socket::getErrorNumber" ref="bfdaefd24888f2d51089bdb31894286e" 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"><a class="el" href="classost_1_1_socket.html#3306a277326459f69aa69b474f50d6e2">Error</a> ost::Socket::getErrorNumber </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Often used by a "catch" to fetch the last error of a thrown socket.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>error number of Error error. </dd></dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpthread_8cpp-example.html#a86">tcpthread.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="d1c8bb17f75cfe540853a871081bd9d0"></a><!-- doxytag: member="ost::Socket::getErrorString" ref="d1c8bb17f75cfe540853a871081bd9d0" 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">const char* ost::Socket::getErrorString </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>string for error message. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="f72396adf4cac5113e722447e48b7916"></a><!-- doxytag: member="ost::Socket::getIPV4Local" ref="f72396adf4cac5113e722447e48b7916" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4Local </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the local address and port number this socket is currently bound to.
<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>port</em> </td><td>ptr to port number on local host. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>host address of interface this socket is bound to. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="27574c4f148166ef8857975ba3cbb5a5"></a><!-- doxytag: member="ost::Socket::getIPV4NAT" ref="27574c4f148166ef8857975ba3cbb5a5" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4NAT </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Perform NAT table lookup for this socket.
<p>
Used to allow an application to know the original ip:port pair the the client "thinks" it is connecting to. Used mostly to transparently impersonate a remote server/service.<p>
On error, 0.0.0.0:0 is returned and one of the following error codes is set: errServiceUnavailable - if nat is not supported on the current platform or if it was not compiled; errLookupFail - if the nat syscall failed for some reason (extended error code); errSearchErr - if the socket does not have nat information (i.e. is not nated).<p>
NAT lookup is supported on NetFilter for ipv4 and ipv6 (Linux), IPFilter for ipv4 (Solaris, *BSD except OpenBSD, HP-UX, etc.) and Packet Filter for ipv4 and ipv6 (OpenBSD). When using IPFilter or Packet Filter, the first NAT lookup must be performed as root (the NAT device is read only for root and is opened once, unless an error occurs). Permissions on the nat device may be changed to solve this.<p>
<dl compact><dt><b>Warning:</b></dt><dd>When using IPFilter and Packet Filter, application data model must be the same as the running kernel (32/64 bits).</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>port</em> </td><td>ptr to NATed port number on local host. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>NATed host address that this socket is related to. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="8c8d2cfd48c75b03dc776b38b1c095f7"></a><!-- doxytag: member="ost::Socket::getIPV4Peer" ref="8c8d2cfd48c75b03dc776b38b1c095f7" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4Peer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the host address and port of the socket this socket is connected to.
<p>
If the socket is currently not in a connected state, then a host address of 0.0.0.0 is returned.<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>port</em> </td><td>ptr to port number of remote socket. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>host address of remote socket. </dd></dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_socket.html#a2d073bd4fa3c3f1c7b70629996c67f7">ost::UDPSocket</a>. </td>
</tr>
</table>
<a class="anchor" name="7853e912f214a1f6fd05b1335f460f35"></a><!-- doxytag: member="ost::Socket::getIPV4Sender" ref="7853e912f214a1f6fd05b1335f460f35" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4Sender </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
May be used to examine the origin of data waiting in the socket receive queue.
<p>
This can tell a TCP server where pending "connect" requests are coming from, or a UDP socket where it's next packet arrived from.<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>port</em> </td><td>ptr to port number of sender. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>host address, test with "isInetAddress()". </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="8410324ca8ddf50751830f59afeaf377"></a><!-- doxytag: member="ost::Socket::getIPV6Local" ref="8410324ca8ddf50751830f59afeaf377" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6Local </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</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="6af9d4d0da053afae46cf26c58c952cc"></a><!-- doxytag: member="ost::Socket::getIPV6NAT" ref="6af9d4d0da053afae46cf26c58c952cc" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6NAT </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</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="d625daf4cffb541c5e8592792d4ee77e"></a><!-- doxytag: member="ost::Socket::getIPV6Peer" ref="d625daf4cffb541c5e8592792d4ee77e" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6Peer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_socket.html#37b34f874ffb96bfc933b4eda0f6e80c">ost::UDPSocket</a>. </td>
</tr>
</table>
<a class="anchor" name="3e4afdfd4efa11d9898558fe852c4230"></a><!-- doxytag: member="ost::Socket::getIPV6Sender" ref="3e4afdfd4efa11d9898558fe852c4230" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6Sender </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</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="ca71d871bfda4dfcab0891cb0c8df1d4"></a><!-- doxytag: member="ost::Socket::getLocal" ref="ca71d871bfda4dfcab0891cb0c8df1d4" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getLocal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classost_1_1_t_c_p_socket.html#a0779bf0973ae5b54a5f323ef62ab4ae">ost::TCPSocket</a>, and <a class="el" href="classost_1_1_t_c_p_v6_socket.html#c886cc40d05790837f9a52bde00c6170">ost::TCPV6Socket</a>. </td>
</tr>
</table>
<a class="anchor" name="c3dded47080c852dcebc9998643e8dc6"></a><!-- doxytag: member="ost::Socket::getNAT" ref="c3dded47080c852dcebc9998643e8dc6" args="(tpport_t *port) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getNAT </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</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="6fd1dffdfe9606e56fba838559ff6d67"></a><!-- doxytag: member="ost::Socket::getPeer" ref="6fd1dffdfe9606e56fba838559ff6d67" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getPeer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_socket.html#5d06e7131790dd26cc3cf0b1531af3a2">ost::UDPSocket</a>.<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcp_8cpp-example.html#a42">tcp.cpp</a>, <a class="el" href="tcpservice_8cpp-example.html#a51">tcpservice.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#a87">tcpthread.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="99197c017c07c6b24d622b107fa46833"></a><!-- doxytag: member="ost::Socket::getSender" ref="99197c017c07c6b24d622b107fa46833" args="(tpport_t *port=NULL) 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"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getSender </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>port</em> = <code>NULL</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</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="7720aace2bf055d21a6fc33007c88197"></a><!-- doxytag: member="ost::Socket::getSystemError" ref="7720aace2bf055d21a6fc33007c88197" 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">long ost::Socket::getSystemError </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]</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="69b34d0fdbb94b77df4647cdb8b98407"></a><!-- doxytag: member="ost::Socket::getSystemErrorString" ref="69b34d0fdbb94b77df4647cdb8b98407" 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">const char* ost::Socket::getSystemErrorString </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</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="114e5d4cad99aaff24718b05bd3e8e31"></a><!-- doxytag: member="ost::Socket::isActive" ref="114e5d4cad99aaff24718b05bd3e8e31" 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::Socket::isActive </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Test to see if the socket is at least operating or if it is mearly initialized.
<p>
"initialized" sockets may be the result of failed constructors.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if not in initial state. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="8120ca95daa7c488255c308998427ccb"></a><!-- doxytag: member="ost::Socket::isBroadcast" ref="8120ca95daa7c488255c308998427ccb" 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::Socket::isBroadcast </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return if broadcast has been enabled for the specified socket.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if broadcast socket. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="2997c1ed398ce1c6dbf1eb62301f97cc"></a><!-- doxytag: member="ost::Socket::isConnected" ref="2997c1ed398ce1c6dbf1eb62301f97cc" 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::Socket::isConnected </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Can test to see if this socket is "connected", and hence whether a "catch" can safely call <a class="el" href="classost_1_1_socket.html#6fd1dffdfe9606e56fba838559ff6d67">getPeer()</a>.
<p>
Of course, an unconnected socket will return a 0.0.0.0 address from <a class="el" href="classost_1_1_socket.html#6fd1dffdfe9606e56fba838559ff6d67">getPeer()</a> as well.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true when socket is connected to a peer. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="8eb84be4b5cc91731c16be4f32f5bf3d"></a><!-- doxytag: member="ost::Socket::isPending" ref="8eb84be4b5cc91731c16be4f32f5bf3d" args="(Pending pend, timeout_t timeout=TIMEOUT_INF)" --><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 bool ost::Socket::isPending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#c2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a> </td>
<td class="mdname" nowrap> <em>pend</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>TIMEOUT_INF</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the status of pending operations.
<p>
This can be used to examine if input or output is waiting, or if an error has occured on the descriptor.<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if ready, false on timeout. </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>pend</em> </td><td>ready check to perform. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>in milliseconds, inf. if not specified. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="0a1e09a4411bf60bb5e2b6235d4e6a46"></a><!-- doxytag: member="ost::Socket::isRouted" ref="0a1e09a4411bf60bb5e2b6235d4e6a46" 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::Socket::isRouted </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]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return if socket routing is enabled.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if routing enabled. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="b7d4e7cfd0411833ab0b02db1dbed8d5"></a><!-- doxytag: member="ost::Socket::join" ref="b7d4e7cfd0411833ab0b02db1dbed8d5" args="(const IPV6Multicast &ia)" --><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::Socket::join </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</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>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#3d1491c118a0609aa6f67aed9a7a5103">ost::UDPReceive</a>. </td>
</tr>
</table>
<a class="anchor" name="fb0e2d234f461ce45711bff52ffc96ad"></a><!-- doxytag: member="ost::Socket::join" ref="fb0e2d234f461ce45711bff52ffc96ad" args="(const IPV4Multicast &ia)" --><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::Socket::join </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>ia</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>
Join a multicast group.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </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 multicast group to join. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#29df9040b68e4e6b99a03827d7e112c8">ost::UDPReceive</a>. </td>
</tr>
</table>
<a class="anchor" name="5e2c05b34bded0db1bcdcf08bd44f052"></a><!-- doxytag: member="ost::Socket::operator!" ref="5e2c05b34bded0db1bcdcf08bd44f052" args="() 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::Socket::operator! </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Operator based testing to see if a socket is currently active.
<p>
<p>
Reimplemented in <a class="el" href="classost_1_1unixstream.html#e2fd7abfaf4da197090ba24f42fa255d">ost::unixstream</a>. </td>
</tr>
</table>
<a class="anchor" name="b0d02dbca94775d6b28c9d313b55fdcc"></a><!-- doxytag: member="ost::Socket::operator=" ref="b0d02dbca94775d6b28c9d313b55fdcc" args="(const Socket &from)" --><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">Socket</a>& ost::Socket::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classost_1_1_socket.html">Socket</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>from</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>
Sockets may also be duplicated by the assignment operator.
<p>
</td>
</tr>
</table>
<a class="anchor" name="344ae2c256e388447f198288d2d0b41d"></a><!-- doxytag: member="ost::Socket::readData" ref="344ae2c256e388447f198288d2d0b41d" args="(void *buf, size_t len, char separator=0, timeout_t t=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">virtual ssize_t ost::Socket::readData </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" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>char </td>
<td class="mdname" nowrap> <em>separator</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>t</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Read in a block of len bytes with specific separator.
<p>
Can be zero, or any other char. If \n or \r, it's treated just like a <a class="el" href="classost_1_1_socket.html#74e77522b18ff7f10774c2fd333b99c3">readLine()</a>. Otherwise it looks for the separator.<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 byte allocation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>maximum length to read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>separator</em> </td><td>separator for a particular ASCII character </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>timeout for pending data in milliseconds. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="74e77522b18ff7f10774c2fd333b99c3"></a><!-- doxytag: member="ost::Socket::readLine" ref="74e77522b18ff7f10774c2fd333b99c3" args="(char *buf, size_t len, 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">ssize_t ost::Socket::readLine </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">char * </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" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timeout</em> = <code>0</code></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 class="el" href="classost_1_1_process.html">Process</a> a logical input line from a socket descriptor directly.
<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 string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>maximum length to read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>for pending data in milliseconds. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="e3bd5146ee9b4b5dbc0da8bbbc8457ce"></a><!-- doxytag: member="ost::Socket::receiveBuffer" ref="e3bd5146ee9b4b5dbc0da8bbbc8457ce" args="(unsigned size)" --><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::Socket::receiveBuffer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned </td>
<td class="mdname1" valign="top" nowrap> <em>size</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>
Set the protocol stack network kernel receive buffer size associated with the socket.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>errSuccess on success, or error. </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>size</em> </td><td>of buffer in bytes. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e9b26fb7d8253c5507d9d1b92bd50742"></a><!-- doxytag: member="ost::Socket::receiveLimit" ref="e9b26fb7d8253c5507d9d1b92bd50742" args="(int limit=1)" --><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::Socket::receiveLimit </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>limit</em> = <code>1</code> </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>
Set thr receive limit.
<p>
</td>
</tr>
</table>
<a class="anchor" name="20b144ed2110e3b1c597875aa44be6df"></a><!-- doxytag: member="ost::Socket::receiveTimeout" ref="20b144ed2110e3b1c597875aa44be6df" args="(timeout_t timer)" --><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::Socket::receiveTimeout </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>timer</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>
Receive timeout for receiving raw network data.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>errSuccess if set. </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>timer</em> </td><td>value in milliseconds. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="20ad4739d705c429a9eb5388e4a3bccf"></a><!-- doxytag: member="ost::Socket::sendBuffer" ref="20ad4739d705c429a9eb5388e4a3bccf" args="(unsigned size)" --><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::Socket::sendBuffer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned </td>
<td class="mdname1" valign="top" nowrap> <em>size</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>
Set the protocol stack network kernel send buffer size associated with the socket.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>errSuccess on success, or error. </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>size</em> </td><td>of buffer in bytes. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="101d527767089e3df6d8cbff84829791"></a><!-- doxytag: member="ost::Socket::sendLimit" ref="101d527767089e3df6d8cbff84829791" args="(int limit=2048)" --><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::Socket::sendLimit </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>limit</em> = <code>2048</code> </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>
Set the send limit.
<p>
</td>
</tr>
</table>
<a class="anchor" name="e7db59127b8297729d668d4eeed8ccab"></a><!-- doxytag: member="ost::Socket::sendTimeout" ref="e7db59127b8297729d668d4eeed8ccab" args="(timeout_t timer)" --><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::Socket::sendTimeout </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>timer</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>
Set the send timeout for sending raw network data.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>errSuccess if set. </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>timer</em> </td><td>value in millisec. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="1a507041ee5741bcdc906707b1735781"></a><!-- doxytag: member="ost::Socket::setBroadcast" ref="1a507041ee5741bcdc906707b1735781" args="(bool enable)" --><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::Socket::setBroadcast </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</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>
Set the subnet broadcast flag for the socket.
<p>
This enables sending to a subnet and may require special image privileges depending on the operating system.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </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>enable</em> </td><td>when set to true. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#86e9e41d05629a5e6f3029ace0d55e38">ost::UDPTransmit</a>. </td>
</tr>
</table>
<a class="anchor" name="16eb72794ce956b2af6b935eb59b2e24"></a><!-- doxytag: member="ost::Socket::setCompletion" ref="16eb72794ce956b2af6b935eb59b2e24" args="(bool immediate)" --><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::Socket::setCompletion </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>immediate</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>
Used to specify blocking mode for the socket.
<p>
A socket can be made non-blocking by setting setCompletion(false) or set to block on all access with setCompletion(true). I do not believe this form of non-blocking socket I/O is supported in winsock, though it provides an alternate asynchronous set of socket services.<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>immediate</em> </td><td>mode specify socket I/O call blocking mode. </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="tcpservice_8cpp-example.html#a52">tcpservice.cpp</a>.</dl> </td>
</tr>
</table>
<a class="anchor" name="6f54a68eab25ab41bbe13ba87a48b435"></a><!-- doxytag: member="ost::Socket::setError" ref="6f54a68eab25ab41bbe13ba87a48b435" args="(bool enable)" --><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::Socket::setError </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
<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>enable</em> </td><td>true to enable handler. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="866263b2933c0b7b649829f07ca288ff"></a><!-- doxytag: member="ost::Socket::setKeepAlive" ref="866263b2933c0b7b649829f07ca288ff" args="(bool enable)" --><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::Socket::setKeepAlive </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</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>
Set the keep-alive status of this socket and if keep-alive messages will be sent.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 on success. </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>enable</em> </td><td>keep alive messages. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="8a7b1c8f4735ffb2c8e7248e4bf37ef3"></a><!-- doxytag: member="ost::Socket::setLinger" ref="8a7b1c8f4735ffb2c8e7248e4bf37ef3" args="(bool linger)" --><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::Socket::setLinger </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>linger</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>
Enable lingering sockets on close.
<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>linger</em> </td><td>specify linger enable. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="08683bc57bede572b8effb07a3fc68dc"></a><!-- doxytag: member="ost::Socket::setLoopbackByFamily" ref="08683bc57bede572b8effb07a3fc68dc" args="(bool enable, Family family=IPV4)" --><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::Socket::setLoopbackByFamily </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname" nowrap> <em>enable</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_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td>
<td class="mdname" nowrap> <em>family</em> = <code>IPV4</code></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>
Set the multicast loopback flag for the socket.
<p>
Loopback enables a socket to hear what it is sending.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </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>enable</em> </td><td>when set to true. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>of protocol. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="09b396c3fc7316061a3f0539e918a43f"></a><!-- doxytag: member="ost::Socket::setMulticastByFamily" ref="09b396c3fc7316061a3f0539e918a43f" args="(bool enable, Family family=IPV4)" --><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::Socket::setMulticastByFamily </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname" nowrap> <em>enable</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_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td>
<td class="mdname" nowrap> <em>family</em> = <code>IPV4</code></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>
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
<p>
It is also used as a check flag to make sure multicast is enabled before multicast operations are used.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </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>enable</em> </td><td>when set to true. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>family</em> </td><td>of protocol. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a2c47291cf56762847cf82edfc63e473"></a><!-- doxytag: member="ost::Socket::setNoDelay" ref="a2c47291cf56762847cf82edfc63e473" args="(bool enable)" --><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::Socket::setNoDelay </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</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>
Enable/disable delaying packets (Nagle algorithm).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 on success. </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>enable</em> </td><td>disable Nagle algorithm when set to true. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="2165fdf85e39e6a8aaff3da889ae7e20"></a><!-- doxytag: member="ost::Socket::setRouting" ref="2165fdf85e39e6a8aaff3da889ae7e20" args="(bool enable)" --><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::Socket::setRouting </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>enable</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>
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 on success. </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>enable</em> </td><td>normal routing when set to true. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#04ebd34e6cfc70146bfe3789c31d8903">ost::UDPTransmit</a>, and <a class="el" href="classost_1_1_u_d_p_receive.html#e28ec2a16ac42d1a14f015ca5daa260f">ost::UDPReceive</a>. </td>
</tr>
</table>
<a class="anchor" name="23d69227150ae996caf76b01024c1b20"></a><!-- doxytag: member="ost::Socket::setTimeToLiveByFamily" ref="23d69227150ae996caf76b01024c1b20" args="(unsigned char ttl, Family fam=IPV4)" --><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::Socket::setTimeToLiveByFamily </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned char </td>
<td class="mdname" nowrap> <em>ttl</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_socket.html#aa032e41b920b38a79c875b8ae375799">Family</a> </td>
<td class="mdname" nowrap> <em>fam</em> = <code>IPV4</code></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>
Set the multicast time to live for a multicast socket.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </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>ttl</em> </td><td>time to live. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fam</em> </td><td>family of protocol. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e49df7e3c3913147116d8491f77a1b63"></a><!-- doxytag: member="ost::Socket::setTypeOfService" ref="e49df7e3c3913147116d8491f77a1b63" args="(Tos service)" --><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::Socket::setTypeOfService </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_socket.html#7caa0e1bb24b387bd1c5b8240ea592e1">Tos</a> </td>
<td class="mdname1" valign="top" nowrap> <em>service</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>
Set packet scheduling on platforms which support ip quality of service conventions.
<p>
This effects how packets in the queue are scheduled through the interface.<p>
<dl compact><dt><b>Returns:</b></dt><dd>0 on success, error code on failure. </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>service</em> </td><td>type of service enumerated type. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e81f041407f05517bc1a8b30896965f3"></a><!-- doxytag: member="ost::Socket::writeData" ref="e81f041407f05517bc1a8b30896965f3" args="(const void *buf, size_t len, timeout_t t=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">virtual ssize_t ost::Socket::writeData </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" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>t</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Write a block of len bytes to socket.
<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 byte allocation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>maximum length to write. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>timeout for pending data in milliseconds. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="15cb7666fe8982dc64e01354ac48dac4"></a><!-- doxytag: member="ost::Socket::dupSocket" ref="15cb7666fe8982dc64e01354ac48dac4" args="(SOCKET s, Socket::State state)" --><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="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> dupSocket </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> </td>
<td class="mdname" nowrap> <em>s</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_socket.html#c8890572886dca1a03a775997f04abba">Socket::State</a> </td>
<td class="mdname" nowrap> <em>state</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><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><h2>Member Data Documentation</h2>
<a class="anchor" name="2b6b25a155d401b661d62eef57754bfa"></a><!-- doxytag: member="ost::Socket::broadcast" ref="2b6b25a155d401b661d62eef57754bfa" 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">bool <a class="el" href="classost_1_1_socket.html#2b6b25a155d401b661d62eef57754bfa">ost::Socket::broadcast</a><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="f1ef1afa83f77869dc56910ff289d0c5"></a><!-- doxytag: member="ost::Socket::completion" ref="f1ef1afa83f77869dc56910ff289d0c5" 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">bool <a class="el" href="classost_1_1_socket.html#f1ef1afa83f77869dc56910ff289d0c5">ost::Socket::completion</a><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="16622c150177604c25b58072f1985225"></a><!-- doxytag: member="ost::Socket::flags" ref="16622c150177604c25b58072f1985225" 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">struct { ... } <a class="el" href="classost_1_1_socket.html#16622c150177604c25b58072f1985225">ost::Socket::flags</a><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="507d2a060e03c63bbdf0599ffa9d555a"></a><!-- doxytag: member="ost::Socket::keepalive" ref="507d2a060e03c63bbdf0599ffa9d555a" 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">bool <a class="el" href="classost_1_1_socket.html#507d2a060e03c63bbdf0599ffa9d555a">ost::Socket::keepalive</a><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="617e01f010e15ec81be466052a5a378e"></a><!-- doxytag: member="ost::Socket::linger" ref="617e01f010e15ec81be466052a5a378e" 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">bool <a class="el" href="classost_1_1_socket.html#617e01f010e15ec81be466052a5a378e">ost::Socket::linger</a><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="19604a7ca524f3ee4c7623c7c237ff69"></a><!-- doxytag: member="ost::Socket::loopback" ref="19604a7ca524f3ee4c7623c7c237ff69" 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">bool <a class="el" href="classost_1_1_socket.html#19604a7ca524f3ee4c7623c7c237ff69">ost::Socket::loopback</a><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="85db9df29af07929253387d76c59ab2b"></a><!-- doxytag: member="ost::Socket::multicast" ref="85db9df29af07929253387d76c59ab2b" 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">bool <a class="el" href="classost_1_1_socket.html#85db9df29af07929253387d76c59ab2b">ost::Socket::multicast</a><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="795099d3d68f4c3bf7731f263cbd1ace"></a><!-- doxytag: member="ost::Socket::mutex" ref="795099d3d68f4c3bf7731f263cbd1ace" 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"><a class="el" href="classost_1_1_mutex.html">Mutex</a> <a class="el" href="classost_1_1_socket.html#795099d3d68f4c3bf7731f263cbd1ace">ost::Socket::mutex</a><code> [static, 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="118af6ea8eba44a8dbe687f2d31a9022"></a><!-- doxytag: member="ost::Socket::route" ref="118af6ea8eba44a8dbe687f2d31a9022" 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">bool <a class="el" href="classost_1_1_socket.html#118af6ea8eba44a8dbe687f2d31a9022">ost::Socket::route</a><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="f1291caf47c2e2e72a3214e4da206b07"></a><!-- doxytag: member="ost::Socket::so" ref="f1291caf47c2e2e72a3214e4da206b07" 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"><a class="el" href="socket_8h.html#8dc8083897335125630f1af5dafd5831">SOCKET</a> volatile <a class="el" href="classost_1_1_socket.html#f1291caf47c2e2e72a3214e4da206b07">ost::Socket::so</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
the actual socket descriptor, in Windows, unlike posix it *cannot* be used as an file descriptor that way madness lies -- jfc
<p>
</td>
</tr>
</table>
<a class="anchor" name="72526c7c326a7faa20e96e9be01981ba"></a><!-- doxytag: member="ost::Socket::state" ref="72526c7c326a7faa20e96e9be01981ba" 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"><a class="el" href="classost_1_1_socket.html#c8890572886dca1a03a775997f04abba">State</a> volatile <a class="el" href="classost_1_1_socket.html#72526c7c326a7faa20e96e9be01981ba">ost::Socket::state</a><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="9ade0c61ad6d9b0d27c71497b6e68bd5"></a><!-- doxytag: member="ost::Socket::thrown" ref="9ade0c61ad6d9b0d27c71497b6e68bd5" 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">bool <a class="el" href="classost_1_1_socket.html#9ade0c61ad6d9b0d27c71497b6e68bd5">ost::Socket::thrown</a><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="6adc7a5d594ab3b8bace496f7a6757e9"></a><!-- doxytag: member="ost::Socket::ttl" ref="6adc7a5d594ab3b8bace496f7a6757e9" 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">unsigned <a class="el" href="classost_1_1_socket.html#6adc7a5d594ab3b8bace496f7a6757e9">ost::Socket::ttl</a><code> [protected]</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="socket_8h-source.html">socket.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>
