<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::Socket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_socket.html">Socket</a>
</div>
</div>
<div class="contents">
<h1>ost::Socket Class Reference</h1><!-- doxytag: class="ost::Socket" -->
<p>The <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a> is used as the base for all Internet protocol services under Common C++.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="socket_8h_source.html">socket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::Socket:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_socket.png" usemap="#ost::Socket_map" alt=""/>
<map id="ost::Socket_map" name="ost::Socket_map">
<area href="classost_1_1_d_c_c_p_socket.html" alt="ost::DCCPSocket" shape="rect" coords="144,56,278,80"/>
<area href="classost_1_1_simple_t_c_p_stream.html" alt="ost::SimpleTCPStream" shape="rect" coords="144,112,278,136"/>
<area href="classost_1_1_socket_port.html" alt="ost::SocketPort" shape="rect" coords="144,168,278,192"/>
<area href="classost_1_1_t_c_p_socket.html" alt="ost::TCPSocket" shape="rect" coords="144,224,278,248"/>
<area href="classost_1_1_t_c_p_stream.html" alt="ost::TCPStream" shape="rect" coords="144,280,278,304"/>
<area href="classost_1_1_t_c_p_v6_socket.html" alt="ost::TCPV6Socket" shape="rect" coords="144,336,278,360"/>
<area href="classost_1_1_u_d_p_socket.html" alt="ost::UDPSocket" shape="rect" coords="144,392,278,416"/>
<area href="classost_1_1_unix_socket.html" alt="ost::UnixSocket" shape="rect" coords="144,448,278,472"/>
<area href="classost_1_1_unix_stream.html" alt="ost::UnixStream" shape="rect" coords="144,504,278,528"/>
</map>
</div>
</div>
<p><a href="classost_1_1_socket-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> { <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206efae49b01941932c262f6fbbc8e21d3340d">IPV6</a> = AF_INET6,
<a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206efa5bd9a46a5c0f46815c98feeb02e5e926">IPV4</a> = AF_INET
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> { <br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa706ac48f0deba4e591d9668ea79962e8">errSuccess</a> = 0,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa8d1d01d77a141c804b50456d70b94e46">errCreateFailed</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa394bc212b3ab9c69dcb47b1412cedb53">errCopyFailed</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3faa5b3fc41be74d485b9aca2af43d27424">errInput</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fac1c33a97e722515f9851b116dc7bf2c5">errInputInterrupt</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa5833cd0e1a43ae7d420e62ce0851611e">errResourceFailure</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa1c7ee1231e7e7f8e8b6b1447d6f15090">errOutput</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3faf67d1bcf85481bc4dd222f91e92deeb4">errOutputInterrupt</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa672dcab0341a211dcb14e0f848e9b5f9">errNotConnected</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fade54564fcb05a1744ccbf94f5a1b57a5">errConnectRefused</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa837e20c1c3c6cf12d670f87afc1e8f66">errConnectRejected</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3faf1a03fa32f971b5077ebf1cf749e90fa">errConnectTimeout</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa7646955354dce1249d606a2369ea6eaa">errConnectFailed</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa1629a51edc39b379b3736a07d07bd782">errConnectInvalid</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fad21ca357b1645094f6ddcbac26a4deed">errConnectBusy</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa42e56e9bcd983284be704de1400d991d">errConnectNoRoute</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa61d62014cda69b8d77dd07141f59252b">errBindingFailed</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fac3609d1255c9a57b86edc1c9a9a79e42">errBroadcastDenied</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3faa352506dcb7b1d118837c1808944466f">errRoutingDenied</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa4e60741a75df84410263a3113090f55a">errKeepaliveDenied</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa6a5e613ed6f8b222d924e419943a870c">errServiceDenied</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa4739d2c04636eff1971b3648bda5f672">errServiceUnavailable</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa8753eb8cc4591d5288c72ba2c91ea956">errMulticastDisabled</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa5d0c869dc200b3cd1eab866816dc217a">errTimeout</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fafe1fd02e79a208ee781a5b41f7fb5814">errNoDelay</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa8f699326e6567ea4171d5821fa417e35">errExtended</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa337bdb7f7512963ef0354f8be541c71e">errLookupFail</a>,
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa8939131de2df58fc2327933cbd024e49">errSearchErr</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3fa9ede2afac3c4df2fd5671d48cbf546dc">errInvalidValue</a>
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">Tos</a> { <br/>
<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890a2199fbf8a1e891120f27a67559e9b6ff">tosLowDelay</a> = 0,
<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890ae805c8e2bc547dbc94b32ccc19c1396b">tosThroughput</a>,
<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890ad0e7d077cb9c6e6f3e702bc735af87d4">tosReliability</a>,
<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890aed0323ec6ea800b824853441c4ccd3e8">tosMinCost</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890ac0b92a366fed8d304b3c91323aa49a15">tosInvalid</a>
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> { <a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8af2d41647f208c78eb97fe77196c55ccc">pendingInput</a>,
<a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8a0c9ffb2c87eb616774ea812fc9739efd">pendingOutput</a>,
<a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8ad3bac41d6ea72956235766139b8742d6">pendingError</a>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#aaa032e41b920b38a79c875b8ae375799">Family</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a3306a277326459f69aa69b474f50d6e2">Error</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">Tos</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a7caa0e1bb24b387bd1c5b8240ea592e1">Tos</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ac2fe3b8bf4dfc66c7df11dfa1ce4415c">Pending</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a801b3892635919626d7fc8f3d03da933">~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="#a801b3892635919626d7fc8f3d03da933"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#ab0d02dbca94775d6b28c9d313b55fdcc">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="#ab0d02dbca94775d6b28c9d313b55fdcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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#a68a7acd6af1686e66e88e9e466a9903f">getIPV4Sender</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">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="#a68a7acd6af1686e66e88e9e466a9903f"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a99197c017c07c6b24d622b107fa46833">getSender</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <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#a4f1e7645a2d543e0a665b111c2dba8e9">getIPV6Sender</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" 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#a8c8d2cfd48c75b03dc776b38b1c095f7">getIPV4Peer</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">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="#a8c8d2cfd48c75b03dc776b38b1c095f7"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#a6fd1dffdfe9606e56fba838559ff6d67">getPeer</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" 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#ad625daf4cffb541c5e8592792d4ee77e">getIPV6Peer</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" 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#af72396adf4cac5113e722447e48b7916">getIPV4Local</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">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="#af72396adf4cac5113e722447e48b7916"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#aca71d871bfda4dfcab0891cb0c8df1d4">getLocal</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" 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#a8410324ca8ddf50751830f59afeaf377">getIPV6Local</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" 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#a27574c4f148166ef8857975ba3cbb5a5">getIPV4NAT</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">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="#a27574c4f148166ef8857975ba3cbb5a5"></a><br/></td></tr>
<tr><td class="memItemLeft" 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#ac3dded47080c852dcebc9998643e8dc6">getNAT</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port) const </td></tr>
<tr><td class="memItemLeft" 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#a6af9d4d0da053afae46cf26c58c952cc">getIPV6NAT</a> (<a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> *port=NULL) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a16eb72794ce956b2af6b935eb59b2e24">setCompletion</a> (bool immediate)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to specify blocking mode for the socket. <a href="#a16eb72794ce956b2af6b935eb59b2e24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a8a7b1c8f4735ffb2c8e7248e4bf37ef3">setLinger</a> (bool <a class="el" href="classost_1_1_socket.html#a617e01f010e15ec81be466052a5a378e">linger</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable lingering sockets on close. <a href="#a8a7b1c8f4735ffb2c8e7248e4bf37ef3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a866263b2933c0b7b649829f07ca288ff">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="#a866263b2933c0b7b649829f07ca288ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ae49df7e3c3913147116d8491f77a1b63">setTypeOfService</a> (<a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">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="#ae49df7e3c3913147116d8491f77a1b63"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a2997c1ed398ce1c6dbf1eb62301f97cc">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#a6fd1dffdfe9606e56fba838559ff6d67">getPeer()</a>. <a href="#a2997c1ed398ce1c6dbf1eb62301f97cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a114e5d4cad99aaff24718b05bd3e8e31">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="#a114e5d4cad99aaff24718b05bd3e8e31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a5e2c05b34bded0db1bcdcf08bd44f052">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="#a5e2c05b34bded0db1bcdcf08bd44f052"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a8120ca95daa7c488255c308998427ccb">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="#a8120ca95daa7c488255c308998427ccb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a0a1e09a4411bf60bb5e2b6235d4e6a46">isRouted</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return if socket routing is enabled. <a href="#a0a1e09a4411bf60bb5e2b6235d4e6a46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#abfdaefd24888f2d51089bdb31894286e">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="#abfdaefd24888f2d51089bdb31894286e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ad1c8bb17f75cfe540853a871081bd9d0">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="#ad1c8bb17f75cfe540853a871081bd9d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a7720aace2bf055d21a6fc33007c88197">getSystemError</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a69b34d0fdbb94b77df4647cdb8b98407">getSystemErrorString</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a8eb84be4b5cc91731c16be4f32f5bf3d">isPending</a> (<a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> pend, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of pending operations. <a href="#a8eb84be4b5cc91731c16be4f32f5bf3d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#af735f45763298ad70b9925518b795837">check</a> (<a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">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="#af735f45763298ad70b9925518b795837"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">State</a> { <br/>
<a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066abd827e310a97ea890353a7ee5f92885c">INITIAL</a>,
<a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066a9181006b79c1fc5111fa9fd8adced04d">AVAILABLE</a>,
<a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066a6f74458d0045b716df163290d56a5c85">BOUND</a>,
<a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066a421a6e01dfd1841341d0dbcd7e821aa6">CONNECTED</a>,
<br/>
<a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066a8240e96a84fba05c787ee8f770bbc47d">CONNECTING</a>,
<a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066af623db6499fd0e2eca13da3c94048fd0">STREAM</a>
<br/>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ac8890572886dca1a03a775997f04abba">State</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#acc5fdba2a70aa9241de6cf59355e47b3">error</a> (<a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> error, const 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="#acc5fdba2a70aa9241de6cf59355e47b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a4f06b1af9c42afcc36739aa6b80982ef">error</a> (const 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="#a4f06b1af9c42afcc36739aa6b80982ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a6f54a68eab25ab41bbe13ba87a48b435">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="#a6f54a68eab25ab41bbe13ba87a48b435"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a3ab340e773f0214eefcf66f588bcf174">endSocket</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used as the default destructor for ending a socket. <a href="#a3ab340e773f0214eefcf66f588bcf174"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a217dc5ca83ea9fe3849bc34b6ee5253d">connectError</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used as a common handler for connection failure processing. <a href="#a217dc5ca83ea9fe3849bc34b6ee5253d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a101d527767089e3df6d8cbff84829791">sendLimit</a> (int limit=2048)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the send limit. <a href="#a101d527767089e3df6d8cbff84829791"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ae9b26fb7d8253c5507d9d1b92bd50742">receiveLimit</a> (int limit=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set thr receive limit. <a href="#ae9b26fb7d8253c5507d9d1b92bd50742"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ae7db59127b8297729d668d4eeed8ccab">sendTimeout</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">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="#ae7db59127b8297729d668d4eeed8ccab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a20b144ed2110e3b1c597875aa44be6df">receiveTimeout</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive timeout for receiving raw network data. <a href="#a20b144ed2110e3b1c597875aa44be6df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a20ad4739d705c429a9eb5388e4a3bccf">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="#a20ad4739d705c429a9eb5388e4a3bccf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ae3bd5146ee9b4b5dbc0da8bbbc8457ce">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="#ae3bd5146ee9b4b5dbc0da8bbbc8457ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#adbc655480acedfcc5febdd28631f0fa7">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="#adbc655480acedfcc5febdd28631f0fa7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a1a507041ee5741bcdc906707b1735781">setBroadcast</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the subnet broadcast flag for the socket. <a href="#a1a507041ee5741bcdc906707b1735781"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a09b396c3fc7316061a3f0539e918a43f">setMulticastByFamily</a> (bool enable, <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">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="#a09b396c3fc7316061a3f0539e918a43f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a08683bc57bede572b8effb07a3fc68dc">setLoopbackByFamily</a> (bool enable, <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> family=IPV4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the multicast loopback flag for the socket. <a href="#a08683bc57bede572b8effb07a3fc68dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a23d69227150ae996caf76b01024c1b20">setTimeToLiveByFamily</a> (unsigned char <a class="el" href="classost_1_1_socket.html#a6adc7a5d594ab3b8bace496f7a6757e9">ttl</a>, <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">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="#a23d69227150ae996caf76b01024c1b20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#afb0e2d234f461ce45711bff52ffc96ad">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="#afb0e2d234f461ce45711bff52ffc96ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ab7d4e7cfd0411833ab0b02db1dbed8d5">join</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ac59c08e11070a1602352da5c54332d9e">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="#ac59c08e11070a1602352da5c54332d9e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a54bb968bfe110dc65bd5d0fb4a47383d">drop</a> (const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> &ia)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a2165fdf85e39e6a8aaff3da889ae7e20">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="#a2165fdf85e39e6a8aaff3da889ae7e20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#aa2c47291cf56762847cf82edfc63e473">setNoDelay</a> (bool enable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable delaying packets (Nagle algorithm). <a href="#aa2c47291cf56762847cf82edfc63e473"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a80235ff77955cff4f3b44dfcd4546939">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="#a80235ff77955cff4f3b44dfcd4546939"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ab626d95fcde74c4e1f1ba1da49b941fb">Socket</a> (<a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">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="#ab626d95fcde74c4e1f1ba1da49b941fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#aeda9b71324d761b3e6ac45c25613d048">Socket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an inactive socket object for base constructors. <a href="#aeda9b71324d761b3e6ac45c25613d048"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#acc82106055495c1b464755807b622689">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" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a> object. <a href="#acc82106055495c1b464755807b622689"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a74e77522b18ff7f10774c2fd333b99c3">readLine</a> (char *buf, size_t len, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classost_1_1_process.html" title="A class for containing portable process related functions that help create portable...">Process</a> a logical input line from a socket descriptor directly. <a href="#a74e77522b18ff7f10774c2fd333b99c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a344ae2c256e388447f198288d2d0b41d">readData</a> (void *buf, size_t len, char separator=0, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">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="#a344ae2c256e388447f198288d2d0b41d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#ae81f041407f05517bc1a8b30896965f3">writeData</a> (const void *buf, size_t len, <a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">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="#ae81f041407f05517bc1a8b30896965f3"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" >struct {</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a9ade0c61ad6d9b0d27c71497b6e68bd5">thrown</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a2b6b25a155d401b661d62eef57754bfa">broadcast</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a118af6ea8eba44a8dbe687f2d31a9022">route</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a507d2a060e03c63bbdf0599ffa9d555a">keepalive</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a19604a7ca524f3ee4c7623c7c237ff69">loopback</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a85db9df29af07929253387d76c59ab2b">multicast</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#af1ef1afa83f77869dc56910ff289d0c5">completion</a>: 1</td></tr>
<tr><td class="memItemLeft" > bool <a class="el" href="classost_1_1_socket.html#a617e01f010e15ec81be466052a5a378e">linger</a>: 1</td></tr>
<tr><td class="memItemLeft" > unsigned <a class="el" href="classost_1_1_socket.html#a6adc7a5d594ab3b8bace496f7a6757e9">ttl</a>: 8</td></tr>
<tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a335f1e849c2adb77955b896ebef1bba2">flags</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> volatile </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#af1291caf47c2e2e72a3214e4da206b07">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="#af1291caf47c2e2e72a3214e4da206b07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">State</a> volatile </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a72526c7c326a7faa20e96e9be01981ba">state</a></td></tr>
<tr><td colspan="2"><h2>Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" 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#a795099d3d68f4c3bf7731f263cbd1ace">mutex</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_socket.html#a15cb7666fe8982dc64e01354ac48dac4">dupSocket</a> (<a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> s, <a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">Socket::State</a> <a class="el" href="classost_1_1_socket.html#a72526c7c326a7faa20e96e9be01981ba">state</a>)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a> is used as the base for all Internet protocol services under Common C++. </p>
<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>
<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 class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> base class of all sockets. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="tcpthread_8cpp-example.html#_a13">tcpthread.cpp</a>.</p>
</dd>
</dl><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a3306a277326459f69aa69b474f50d6e2"></a><!-- doxytag: member="ost::Socket::Error" ref="a3306a277326459f69aa69b474f50d6e2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> <a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">ost::Socket::Error</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#a3cbe53f1c34d7fdbd73efa61edbf463d">ost::URLStream</a>.</p>
</div>
</div>
<a class="anchor" id="aaa032e41b920b38a79c875b8ae375799"></a><!-- doxytag: member="ost::Socket::Family" ref="aaa032e41b920b38a79c875b8ae375799" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">ost::Socket::Family</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac2fe3b8bf4dfc66c7df11dfa1ce4415c"></a><!-- doxytag: member="ost::Socket::Pending" ref="ac2fe3b8bf4dfc66c7df11dfa1ce4415c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> <a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">ost::Socket::Pending</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ac8890572886dca1a03a775997f04abba"></a><!-- doxytag: member="ost::Socket::State" ref="ac8890572886dca1a03a775997f04abba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">State</a> <a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">ost::Socket::State</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7caa0e1bb24b387bd1c5b8240ea592e1"></a><!-- doxytag: member="ost::Socket::Tos" ref="a7caa0e1bb24b387bd1c5b8240ea592e1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">Tos</a> <a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">ost::Socket::Tos</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3f"></a><!-- doxytag: member="ost::Socket::Error" ref="ae056b6dd4f167163083b7ab602fd3f3f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">ost::Socket::Error</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa706ac48f0deba4e591d9668ea79962e8"></a><!-- doxytag: member="errSuccess" ref="ae056b6dd4f167163083b7ab602fd3f3fa706ac48f0deba4e591d9668ea79962e8" args="" -->errSuccess</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa8d1d01d77a141c804b50456d70b94e46"></a><!-- doxytag: member="errCreateFailed" ref="ae056b6dd4f167163083b7ab602fd3f3fa8d1d01d77a141c804b50456d70b94e46" args="" -->errCreateFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa394bc212b3ab9c69dcb47b1412cedb53"></a><!-- doxytag: member="errCopyFailed" ref="ae056b6dd4f167163083b7ab602fd3f3fa394bc212b3ab9c69dcb47b1412cedb53" args="" -->errCopyFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3faa5b3fc41be74d485b9aca2af43d27424"></a><!-- doxytag: member="errInput" ref="ae056b6dd4f167163083b7ab602fd3f3faa5b3fc41be74d485b9aca2af43d27424" args="" -->errInput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fac1c33a97e722515f9851b116dc7bf2c5"></a><!-- doxytag: member="errInputInterrupt" ref="ae056b6dd4f167163083b7ab602fd3f3fac1c33a97e722515f9851b116dc7bf2c5" args="" -->errInputInterrupt</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa5833cd0e1a43ae7d420e62ce0851611e"></a><!-- doxytag: member="errResourceFailure" ref="ae056b6dd4f167163083b7ab602fd3f3fa5833cd0e1a43ae7d420e62ce0851611e" args="" -->errResourceFailure</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa1c7ee1231e7e7f8e8b6b1447d6f15090"></a><!-- doxytag: member="errOutput" ref="ae056b6dd4f167163083b7ab602fd3f3fa1c7ee1231e7e7f8e8b6b1447d6f15090" args="" -->errOutput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3faf67d1bcf85481bc4dd222f91e92deeb4"></a><!-- doxytag: member="errOutputInterrupt" ref="ae056b6dd4f167163083b7ab602fd3f3faf67d1bcf85481bc4dd222f91e92deeb4" args="" -->errOutputInterrupt</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa672dcab0341a211dcb14e0f848e9b5f9"></a><!-- doxytag: member="errNotConnected" ref="ae056b6dd4f167163083b7ab602fd3f3fa672dcab0341a211dcb14e0f848e9b5f9" args="" -->errNotConnected</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fade54564fcb05a1744ccbf94f5a1b57a5"></a><!-- doxytag: member="errConnectRefused" ref="ae056b6dd4f167163083b7ab602fd3f3fade54564fcb05a1744ccbf94f5a1b57a5" args="" -->errConnectRefused</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa837e20c1c3c6cf12d670f87afc1e8f66"></a><!-- doxytag: member="errConnectRejected" ref="ae056b6dd4f167163083b7ab602fd3f3fa837e20c1c3c6cf12d670f87afc1e8f66" args="" -->errConnectRejected</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3faf1a03fa32f971b5077ebf1cf749e90fa"></a><!-- doxytag: member="errConnectTimeout" ref="ae056b6dd4f167163083b7ab602fd3f3faf1a03fa32f971b5077ebf1cf749e90fa" args="" -->errConnectTimeout</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa7646955354dce1249d606a2369ea6eaa"></a><!-- doxytag: member="errConnectFailed" ref="ae056b6dd4f167163083b7ab602fd3f3fa7646955354dce1249d606a2369ea6eaa" args="" -->errConnectFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa1629a51edc39b379b3736a07d07bd782"></a><!-- doxytag: member="errConnectInvalid" ref="ae056b6dd4f167163083b7ab602fd3f3fa1629a51edc39b379b3736a07d07bd782" args="" -->errConnectInvalid</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fad21ca357b1645094f6ddcbac26a4deed"></a><!-- doxytag: member="errConnectBusy" ref="ae056b6dd4f167163083b7ab602fd3f3fad21ca357b1645094f6ddcbac26a4deed" args="" -->errConnectBusy</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa42e56e9bcd983284be704de1400d991d"></a><!-- doxytag: member="errConnectNoRoute" ref="ae056b6dd4f167163083b7ab602fd3f3fa42e56e9bcd983284be704de1400d991d" args="" -->errConnectNoRoute</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa61d62014cda69b8d77dd07141f59252b"></a><!-- doxytag: member="errBindingFailed" ref="ae056b6dd4f167163083b7ab602fd3f3fa61d62014cda69b8d77dd07141f59252b" args="" -->errBindingFailed</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fac3609d1255c9a57b86edc1c9a9a79e42"></a><!-- doxytag: member="errBroadcastDenied" ref="ae056b6dd4f167163083b7ab602fd3f3fac3609d1255c9a57b86edc1c9a9a79e42" args="" -->errBroadcastDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3faa352506dcb7b1d118837c1808944466f"></a><!-- doxytag: member="errRoutingDenied" ref="ae056b6dd4f167163083b7ab602fd3f3faa352506dcb7b1d118837c1808944466f" args="" -->errRoutingDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa4e60741a75df84410263a3113090f55a"></a><!-- doxytag: member="errKeepaliveDenied" ref="ae056b6dd4f167163083b7ab602fd3f3fa4e60741a75df84410263a3113090f55a" args="" -->errKeepaliveDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa6a5e613ed6f8b222d924e419943a870c"></a><!-- doxytag: member="errServiceDenied" ref="ae056b6dd4f167163083b7ab602fd3f3fa6a5e613ed6f8b222d924e419943a870c" args="" -->errServiceDenied</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa4739d2c04636eff1971b3648bda5f672"></a><!-- doxytag: member="errServiceUnavailable" ref="ae056b6dd4f167163083b7ab602fd3f3fa4739d2c04636eff1971b3648bda5f672" args="" -->errServiceUnavailable</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa8753eb8cc4591d5288c72ba2c91ea956"></a><!-- doxytag: member="errMulticastDisabled" ref="ae056b6dd4f167163083b7ab602fd3f3fa8753eb8cc4591d5288c72ba2c91ea956" args="" -->errMulticastDisabled</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa5d0c869dc200b3cd1eab866816dc217a"></a><!-- doxytag: member="errTimeout" ref="ae056b6dd4f167163083b7ab602fd3f3fa5d0c869dc200b3cd1eab866816dc217a" args="" -->errTimeout</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fafe1fd02e79a208ee781a5b41f7fb5814"></a><!-- doxytag: member="errNoDelay" ref="ae056b6dd4f167163083b7ab602fd3f3fafe1fd02e79a208ee781a5b41f7fb5814" args="" -->errNoDelay</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa8f699326e6567ea4171d5821fa417e35"></a><!-- doxytag: member="errExtended" ref="ae056b6dd4f167163083b7ab602fd3f3fa8f699326e6567ea4171d5821fa417e35" args="" -->errExtended</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa337bdb7f7512963ef0354f8be541c71e"></a><!-- doxytag: member="errLookupFail" ref="ae056b6dd4f167163083b7ab602fd3f3fa337bdb7f7512963ef0354f8be541c71e" args="" -->errLookupFail</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa8939131de2df58fc2327933cbd024e49"></a><!-- doxytag: member="errSearchErr" ref="ae056b6dd4f167163083b7ab602fd3f3fa8939131de2df58fc2327933cbd024e49" args="" -->errSearchErr</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae056b6dd4f167163083b7ab602fd3f3fa9ede2afac3c4df2fd5671d48cbf546dc"></a><!-- doxytag: member="errInvalidValue" ref="ae056b6dd4f167163083b7ab602fd3f3fa9ede2afac3c4df2fd5671d48cbf546dc" args="" -->errInvalidValue</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_r_l_stream.html#a3cbe53f1c34d7fdbd73efa61edbf463d">ost::URLStream</a>.</p>
</div>
</div>
<a class="anchor" id="a36a69681caa020f1abed34ae71d206ef"></a><!-- doxytag: member="ost::Socket::Family" ref="a36a69681caa020f1abed34ae71d206ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">ost::Socket::Family</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a36a69681caa020f1abed34ae71d206efae49b01941932c262f6fbbc8e21d3340d"></a><!-- doxytag: member="IPV6" ref="a36a69681caa020f1abed34ae71d206efae49b01941932c262f6fbbc8e21d3340d" args="" -->IPV6</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a36a69681caa020f1abed34ae71d206efa5bd9a46a5c0f46815c98feeb02e5e926"></a><!-- doxytag: member="IPV4" ref="a36a69681caa020f1abed34ae71d206efa5bd9a46a5c0f46815c98feeb02e5e926" args="" -->IPV4</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2cb9ccad21fc2f10c23e45cbb99bc6f8"></a><!-- doxytag: member="ost::Socket::Pending" ref="a2cb9ccad21fc2f10c23e45cbb99bc6f8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">ost::Socket::Pending</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a2cb9ccad21fc2f10c23e45cbb99bc6f8af2d41647f208c78eb97fe77196c55ccc"></a><!-- doxytag: member="pendingInput" ref="a2cb9ccad21fc2f10c23e45cbb99bc6f8af2d41647f208c78eb97fe77196c55ccc" args="" -->pendingInput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a2cb9ccad21fc2f10c23e45cbb99bc6f8a0c9ffb2c87eb616774ea812fc9739efd"></a><!-- doxytag: member="pendingOutput" ref="a2cb9ccad21fc2f10c23e45cbb99bc6f8a0c9ffb2c87eb616774ea812fc9739efd" args="" -->pendingOutput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a2cb9ccad21fc2f10c23e45cbb99bc6f8ad3bac41d6ea72956235766139b8742d6"></a><!-- doxytag: member="pendingError" ref="a2cb9ccad21fc2f10c23e45cbb99bc6f8ad3bac41d6ea72956235766139b8742d6" args="" -->pendingError</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066"></a><!-- doxytag: member="ost::Socket::State" ref="ad17e0a386f4c50a57db3bebe55571066" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">ost::Socket::State</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066abd827e310a97ea890353a7ee5f92885c"></a><!-- doxytag: member="INITIAL" ref="ad17e0a386f4c50a57db3bebe55571066abd827e310a97ea890353a7ee5f92885c" args="" -->INITIAL</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066a9181006b79c1fc5111fa9fd8adced04d"></a><!-- doxytag: member="AVAILABLE" ref="ad17e0a386f4c50a57db3bebe55571066a9181006b79c1fc5111fa9fd8adced04d" args="" -->AVAILABLE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066a6f74458d0045b716df163290d56a5c85"></a><!-- doxytag: member="BOUND" ref="ad17e0a386f4c50a57db3bebe55571066a6f74458d0045b716df163290d56a5c85" args="" -->BOUND</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066a421a6e01dfd1841341d0dbcd7e821aa6"></a><!-- doxytag: member="CONNECTED" ref="ad17e0a386f4c50a57db3bebe55571066a421a6e01dfd1841341d0dbcd7e821aa6" args="" -->CONNECTED</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066a8240e96a84fba05c787ee8f770bbc47d"></a><!-- doxytag: member="CONNECTING" ref="ad17e0a386f4c50a57db3bebe55571066a8240e96a84fba05c787ee8f770bbc47d" args="" -->CONNECTING</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ad17e0a386f4c50a57db3bebe55571066af623db6499fd0e2eca13da3c94048fd0"></a><!-- doxytag: member="STREAM" ref="ad17e0a386f4c50a57db3bebe55571066af623db6499fd0e2eca13da3c94048fd0" args="" -->STREAM</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a258f81f5a42d051242f0f49f8192f890"></a><!-- doxytag: member="ost::Socket::Tos" ref="a258f81f5a42d051242f0f49f8192f890" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">ost::Socket::Tos</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a258f81f5a42d051242f0f49f8192f890a2199fbf8a1e891120f27a67559e9b6ff"></a><!-- doxytag: member="tosLowDelay" ref="a258f81f5a42d051242f0f49f8192f890a2199fbf8a1e891120f27a67559e9b6ff" args="" -->tosLowDelay</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a258f81f5a42d051242f0f49f8192f890ae805c8e2bc547dbc94b32ccc19c1396b"></a><!-- doxytag: member="tosThroughput" ref="a258f81f5a42d051242f0f49f8192f890ae805c8e2bc547dbc94b32ccc19c1396b" args="" -->tosThroughput</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a258f81f5a42d051242f0f49f8192f890ad0e7d077cb9c6e6f3e702bc735af87d4"></a><!-- doxytag: member="tosReliability" ref="a258f81f5a42d051242f0f49f8192f890ad0e7d077cb9c6e6f3e702bc735af87d4" args="" -->tosReliability</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a258f81f5a42d051242f0f49f8192f890aed0323ec6ea800b824853441c4ccd3e8"></a><!-- doxytag: member="tosMinCost" ref="a258f81f5a42d051242f0f49f8192f890aed0323ec6ea800b824853441c4ccd3e8" args="" -->tosMinCost</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a258f81f5a42d051242f0f49f8192f890ac0b92a366fed8d304b3c91323aa49a15"></a><!-- doxytag: member="tosInvalid" ref="a258f81f5a42d051242f0f49f8192f890ac0b92a366fed8d304b3c91323aa49a15" args="" -->tosInvalid</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a80235ff77955cff4f3b44dfcd4546939"></a><!-- doxytag: member="ost::Socket::Socket" ref="a80235ff77955cff4f3b44dfcd4546939" args="(int domain, int type, int protocol=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Socket::Socket </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>domain</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>protocol</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An unconnected socket may be created directly on the local machine. </p>
<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><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab626d95fcde74c4e1f1ba1da49b941fb"></a><!-- doxytag: member="ost::Socket::Socket" ref="ab626d95fcde74c4e1f1ba1da49b941fb" args="(SOCKET fd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Socket::Socket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> </td>
<td class="paramname"> <em>fd</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call. </p>
<p>This constructor is mostly for internal use.</p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aeda9b71324d761b3e6ac45c25613d048"></a><!-- doxytag: member="ost::Socket::Socket" ref="aeda9b71324d761b3e6ac45c25613d048" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Socket::Socket </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an inactive socket object for base constructors. </p>
</div>
</div>
<a class="anchor" id="acc82106055495c1b464755807b622689"></a><!-- doxytag: member="ost::Socket::Socket" ref="acc82106055495c1b464755807b622689" args="(const Socket &source)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::Socket::Socket </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_socket.html">Socket</a> & </td>
<td class="paramname"> <em>source</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A socket can also be constructed from an already existing <a class="el" href="classost_1_1_socket.html" title="The Socket is used as the base for all Internet protocol services under Common C++...">Socket</a> object. </p>
<p>On POSIX systems, the socket file descriptor is dup()'d. On Win32, DuplicateHandle() is used.</p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a801b3892635919626d7fc8f3d03da933"></a><!-- doxytag: member="ost::Socket::~Socket" ref="a801b3892635919626d7fc8f3d03da933" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::Socket::~Socket </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<p>By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="adbc655480acedfcc5febdd28631f0fa7"></a><!-- doxytag: member="ost::Socket::bufferSize" ref="adbc655480acedfcc5febdd28631f0fa7" args="(unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::bufferSize </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the total protocol stack network kernel buffer size for both send and receive together. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errSuccess on success </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af735f45763298ad70b9925518b795837"></a><!-- doxytag: member="ost::Socket::check" ref="af735f45763298ad70b9925518b795837" args="(Family fam)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool ost::Socket::check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>fam</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See if a specific protocol family is available in the current runtime environment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if family available. </dd></dl>
</div>
</div>
<a class="anchor" id="a217dc5ca83ea9fe3849bc34b6ee5253d"></a><!-- doxytag: member="ost::Socket::connectError" ref="a217dc5ca83ea9fe3849bc34b6ee5253d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::connectError </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used as a common handler for connection failure processing. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>correct failure code to apply. </dd></dl>
</div>
</div>
<a class="anchor" id="a54bb968bfe110dc65bd5d0fb4a47383d"></a><!-- doxytag: member="ost::Socket::drop" ref="a54bb968bfe110dc65bd5d0fb4a47383d" args="(const IPV6Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::drop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#a4fb379f4df763e3726c8097d65d4c584">ost::UDPReceive</a>.</p>
</div>
</div>
<a class="anchor" id="ac59c08e11070a1602352da5c54332d9e"></a><!-- doxytag: member="ost::Socket::drop" ref="ac59c08e11070a1602352da5c54332d9e" args="(const IPV4Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::drop </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Drop membership from a multicast group. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#a6ec872d42da02ac13e3390f4ec6cb98d">ost::UDPReceive</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01293">ost::UDPReceive::drop()</a>.</p>
</div>
</div>
<a class="anchor" id="a3ab340e773f0214eefcf66f588bcf174"></a><!-- doxytag: member="ost::Socket::endSocket" ref="a3ab340e773f0214eefcf66f588bcf174" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Socket::endSocket </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used as the default destructor for ending a socket. </p>
<p>This will cleanly terminate the socket connection. It is provided for use in derived virtual destructors. </p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01273">ost::UDPReceive::endReceiver()</a>, and <a class="el" href="socket_8h_source.html#l01171">ost::UDPTransmit::endTransmitter()</a>.</p>
</div>
</div>
<a class="anchor" id="a4f06b1af9c42afcc36739aa6b80982ef"></a><!-- doxytag: member="ost::Socket::error" ref="a4f06b1af9c42afcc36739aa6b80982ef" args="(const char *err) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Socket::error </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>err</em></td>
<td> ) </td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This service is used to throw application defined socket errors where the application specific error code is a string. </p>
<dl><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>
</dd>
</dl>
<p>References <a class="el" href="socket_8h_source.html#l00240">error()</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l00240">error()</a>.</p>
</div>
</div>
<a class="anchor" id="acc5fdba2a70aa9241de6cf59355e47b3"></a><!-- doxytag: member="ost::Socket::error" ref="acc5fdba2a70aa9241de6cf59355e47b3" args="(Error error, const char *err=NULL, long systemError=0) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> </td>
<td class="paramname"> <em>error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>err</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>systemError</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This service is used to throw all socket errors which usually occur during the socket constructor. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abfdaefd24888f2d51089bdb31894286e"></a><!-- doxytag: member="ost::Socket::getErrorNumber" ref="abfdaefd24888f2d51089bdb31894286e" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::getErrorNumber </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Often used by a "catch" to fetch the last error of a thrown socket. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>error number of Error error. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcpthread_8cpp-example.html#a14">tcpthread.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad1c8bb17f75cfe540853a871081bd9d0"></a><!-- doxytag: member="ost::Socket::getErrorString" ref="ad1c8bb17f75cfe540853a871081bd9d0" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::Socket::getErrorString </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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 class="return"><dt><b>Returns:</b></dt><dd>string for error message. </dd></dl>
</div>
</div>
<a class="anchor" id="af72396adf4cac5113e722447e48b7916"></a><!-- doxytag: member="ost::Socket::getIPV4Local" ref="af72396adf4cac5113e722447e48b7916" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4Local </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the local address and port number this socket is currently bound to. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>host address of interface this socket is bound to. </dd></dl>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01472">ost::TCPSocket::getLocal()</a>.</p>
</div>
</div>
<a class="anchor" id="a27574c4f148166ef8857975ba3cbb5a5"></a><!-- doxytag: member="ost::Socket::getIPV4NAT" ref="a27574c4f148166ef8857975ba3cbb5a5" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4NAT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform NAT table lookup for this socket. </p>
<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>
<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>
<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 class="warning"><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><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NATed host address that this socket is related to. </dd></dl>
</div>
</div>
<a class="anchor" id="a8c8d2cfd48c75b03dc776b38b1c095f7"></a><!-- doxytag: member="ost::Socket::getIPV4Peer" ref="a8c8d2cfd48c75b03dc776b38b1c095f7" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4Peer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the host address and port of the socket this socket is connected to. </p>
<p>If the socket is currently not in a connected state, then a host address of 0.0.0.0 is returned.</p>
<dl><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>
</dd>
</dl>
<dl class="return"><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#aa2d073bd4fa3c3f1c7b70629996c67f7">ost::UDPSocket</a>.</p>
</div>
</div>
<a class="anchor" id="a68a7acd6af1686e66e88e9e466a9903f"></a><!-- doxytag: member="ost::Socket::getIPV4Sender" ref="a68a7acd6af1686e66e88e9e466a9903f" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getIPV4Sender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>May be used to examine the origin of data waiting in the socket receive queue. </p>
<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><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>host address, test with "isInetAddress()". </dd></dl>
<p>Reimplemented in <a class="el" href="classost_1_1_d_c_c_p_socket.html#a8121a7ac2a388a35ed30177d35361893">ost::DCCPSocket</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01461">ost::TCPSocket::getRequest()</a>.</p>
</div>
</div>
<a class="anchor" id="a8410324ca8ddf50751830f59afeaf377"></a><!-- doxytag: member="ost::Socket::getIPV6Local" ref="a8410324ca8ddf50751830f59afeaf377" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6Local </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="socket_8h_source.html#l01588">ost::TCPV6Socket::getLocal()</a>.</p>
</div>
</div>
<a class="anchor" id="a6af9d4d0da053afae46cf26c58c952cc"></a><!-- doxytag: member="ost::Socket::getIPV6NAT" ref="a6af9d4d0da053afae46cf26c58c952cc" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6NAT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad625daf4cffb541c5e8592792d4ee77e"></a><!-- doxytag: member="ost::Socket::getIPV6Peer" ref="ad625daf4cffb541c5e8592792d4ee77e" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6Peer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_socket.html#a37b34f874ffb96bfc933b4eda0f6e80c">ost::UDPSocket</a>.</p>
</div>
</div>
<a class="anchor" id="a4f1e7645a2d543e0a665b111c2dba8e9"></a><!-- doxytag: member="ost::Socket::getIPV6Sender" ref="a4f1e7645a2d543e0a665b111c2dba8e9" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classost_1_1_i_p_v6_host.html">IPV6Host</a> ost::Socket::getIPV6Sender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_d_c_c_p_socket.html#a5a3a4390c87849adb3119ad5c1210dd4">ost::DCCPSocket</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01577">ost::TCPV6Socket::getRequest()</a>.</p>
</div>
</div>
<a class="anchor" id="aca71d871bfda4dfcab0891cb0c8df1d4"></a><!-- doxytag: member="ost::Socket::getLocal" ref="aca71d871bfda4dfcab0891cb0c8df1d4" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getLocal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_t_c_p_socket.html#aa0779bf0973ae5b54a5f323ef62ab4ae">ost::TCPSocket</a>, and <a class="el" href="classost_1_1_t_c_p_v6_socket.html#ac886cc40d05790837f9a52bde00c6170">ost::TCPV6Socket</a>.</p>
</div>
</div>
<a class="anchor" id="ac3dded47080c852dcebc9998643e8dc6"></a><!-- doxytag: member="ost::Socket::getNAT" ref="ac3dded47080c852dcebc9998643e8dc6" args="(tpport_t *port) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getNAT </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6fd1dffdfe9606e56fba838559ff6d67"></a><!-- doxytag: member="ost::Socket::getPeer" ref="a6fd1dffdfe9606e56fba838559ff6d67" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getPeer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_socket.html#a5d06e7131790dd26cc3cf0b1531af3a2">ost::UDPSocket</a>.</p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcp_8cpp-example.html#a8">tcp.cpp</a>, <a class="el" href="tcpservice_8cpp-example.html#a6">tcpservice.cpp</a>, and <a class="el" href="tcpthread_8cpp-example.html#a15">tcpthread.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a99197c017c07c6b24d622b107fa46833"></a><!-- doxytag: member="ost::Socket::getSender" ref="a99197c017c07c6b24d622b107fa46833" args="(tpport_t *port=NULL) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_i_p_v4_host.html">IPV4Host</a> ost::Socket::getSender </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceost.html#a3c74a1a40c359fd349f3e3e1b96ebfc7">tpport_t</a> * </td>
<td class="paramname"> <em>port</em> = <code>NULL</code></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7720aace2bf055d21a6fc33007c88197"></a><!-- doxytag: member="ost::Socket::getSystemError" ref="a7720aace2bf055d21a6fc33007c88197" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long ost::Socket::getSystemError </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a69b34d0fdbb94b77df4647cdb8b98407"></a><!-- doxytag: member="ost::Socket::getSystemErrorString" ref="a69b34d0fdbb94b77df4647cdb8b98407" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* ost::Socket::getSystemErrorString </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a114e5d4cad99aaff24718b05bd3e8e31"></a><!-- doxytag: member="ost::Socket::isActive" ref="a114e5d4cad99aaff24718b05bd3e8e31" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Socket::isActive </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test to see if the socket is at least operating or if it is mearly initialized. </p>
<p>"initialized" sockets may be the result of failed constructors.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if not in initial state. </dd></dl>
</div>
</div>
<a class="anchor" id="a8120ca95daa7c488255c308998427ccb"></a><!-- doxytag: member="ost::Socket::isBroadcast" ref="a8120ca95daa7c488255c308998427ccb" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Socket::isBroadcast </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return if broadcast has been enabled for the specified socket. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if broadcast socket. </dd></dl>
</div>
</div>
<a class="anchor" id="a2997c1ed398ce1c6dbf1eb62301f97cc"></a><!-- doxytag: member="ost::Socket::isConnected" ref="a2997c1ed398ce1c6dbf1eb62301f97cc" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Socket::isConnected </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<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#a6fd1dffdfe9606e56fba838559ff6d67">getPeer()</a>. </p>
<p>Of course, an unconnected socket will return a 0.0.0.0 address from <a class="el" href="classost_1_1_socket.html#a6fd1dffdfe9606e56fba838559ff6d67">getPeer()</a> as well.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true when socket is connected to a peer. </dd></dl>
</div>
</div>
<a class="anchor" id="a8eb84be4b5cc91731c16be4f32f5bf3d"></a><!-- doxytag: member="ost::Socket::isPending" ref="a8eb84be4b5cc91731c16be4f32f5bf3d" args="(Pending pend, timeout_t timeout=TIMEOUT_INF)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ost::Socket::isPending </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a2cb9ccad21fc2f10c23e45cbb99bc6f8">Pending</a> </td>
<td class="paramname"> <em>pend</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>TIMEOUT_INF</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the status of pending operations. </p>
<p>This can be used to examine if input or output is waiting, or if an error has occured on the descriptor.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if ready, false on timeout. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_t_c_p_stream.html#aeb71ab0a1a1ff92095e5421701649ad2">ost::TCPStream</a>, <a class="el" href="classost_1_1_simple_t_c_p_stream.html#a74b4194473dc3e76fd85d35930530d16">ost::SimpleTCPStream</a>, and <a class="el" href="classost_1_1_unix_stream.html#a8d15a61a6636da4e17651ebb30884183">ost::UnixStream</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01318">ost::UDPReceive::isInputReady()</a>, <a class="el" href="socket_8h_source.html#l01207">ost::UDPTransmit::isOutputReady()</a>, <a class="el" href="unix_8h_source.html#l00097">ost::UnixSocket::isPendingConnection()</a>, <a class="el" href="socket_8h_source.html#l01596">ost::TCPV6Socket::isPendingConnection()</a>, <a class="el" href="socket_8h_source.html#l01480">ost::TCPSocket::isPendingConnection()</a>, <a class="el" href="socket_8h_source.html#l00843">ost::DCCPSocket::isPendingConnection()</a>, and <a class="el" href="socket_8h_source.html#l01267">ost::UDPReceive::isPendingReceive()</a>.</p>
</div>
</div>
<a class="anchor" id="a0a1e09a4411bf60bb5e2b6235d4e6a46"></a><!-- doxytag: member="ost::Socket::isRouted" ref="a0a1e09a4411bf60bb5e2b6235d4e6a46" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Socket::isRouted </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return if socket routing is enabled. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if routing enabled. </dd></dl>
</div>
</div>
<a class="anchor" id="ab7d4e7cfd0411833ab0b02db1dbed8d5"></a><!-- doxytag: member="ost::Socket::join" ref="ab7d4e7cfd0411833ab0b02db1dbed8d5" args="(const IPV6Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::join </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v6_multicast.html">IPV6Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#a3d1491c118a0609aa6f67aed9a7a5103">ost::UDPReceive</a>.</p>
</div>
</div>
<a class="anchor" id="afb0e2d234f461ce45711bff52ffc96ad"></a><!-- doxytag: member="ost::Socket::join" ref="afb0e2d234f461ce45711bff52ffc96ad" args="(const IPV4Multicast &ia)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::join </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_i_p_v4_multicast.html">IPV4Multicast</a> & </td>
<td class="paramname"> <em>ia</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Join a multicast group. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_receive.html#a29df9040b68e4e6b99a03827d7e112c8">ost::UDPReceive</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01285">ost::UDPReceive::join()</a>.</p>
</div>
</div>
<a class="anchor" id="a5e2c05b34bded0db1bcdcf08bd44f052"></a><!-- doxytag: member="ost::Socket::operator!" ref="a5e2c05b34bded0db1bcdcf08bd44f052" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::Socket::operator! </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Operator based testing to see if a socket is currently active. </p>
<p>Reimplemented in <a class="el" href="classost_1_1unixstream.html#ae2fd7abfaf4da197090ba24f42fa255d">ost::unixstream</a>.</p>
</div>
</div>
<a class="anchor" id="ab0d02dbca94775d6b28c9d313b55fdcc"></a><!-- doxytag: member="ost::Socket::operator=" ref="ab0d02dbca94775d6b28c9d313b55fdcc" args="(const Socket &from)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html">Socket</a>& ost::Socket::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_socket.html">Socket</a> & </td>
<td class="paramname"> <em>from</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sockets may also be duplicated by the assignment operator. </p>
</div>
</div>
<a class="anchor" id="a344ae2c256e388447f198288d2d0b41d"></a><!-- doxytag: member="ost::Socket::readData" ref="a344ae2c256e388447f198288d2d0b41d" args="(void *buf, size_t len, char separator=0, timeout_t t=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ssize_t ost::Socket::readData </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>separator</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>t</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read in a block of len bytes with specific separator. </p>
<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#a74e77522b18ff7f10774c2fd333b99c3" title="Process a logical input line from a socket descriptor directly.">readLine()</a>. Otherwise it looks for the separator.</p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
<p>Reimplemented in <a class="el" href="classost_1_1_s_s_l_stream.html#a2b9f7b71afaf4e23fcdc8f1fa5fea780">ost::SSLStream</a>.</p>
</div>
</div>
<a class="anchor" id="a74e77522b18ff7f10774c2fd333b99c3"></a><!-- doxytag: member="ost::Socket::readLine" ref="a74e77522b18ff7f10774c2fd333b99c3" args="(char *buf, size_t len, timeout_t timeout=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ssize_t ost::Socket::readLine </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classost_1_1_process.html" title="A class for containing portable process related functions that help create portable...">Process</a> a logical input line from a socket descriptor directly. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes actually read. </dd></dl>
<p>Reimplemented in <a class="el" href="classost_1_1_s_s_l_stream.html#a6ea5b146a83b854ab60ed9bfc8a7b2e0">ost::SSLStream</a>.</p>
</div>
</div>
<a class="anchor" id="ae3bd5146ee9b4b5dbc0da8bbbc8457ce"></a><!-- doxytag: member="ost::Socket::receiveBuffer" ref="ae3bd5146ee9b4b5dbc0da8bbbc8457ce" args="(unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::receiveBuffer </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the protocol stack network kernel receive buffer size associated with the socket. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errSuccess on success, or error. </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae9b26fb7d8253c5507d9d1b92bd50742"></a><!-- doxytag: member="ost::Socket::receiveLimit" ref="ae9b26fb7d8253c5507d9d1b92bd50742" args="(int limit=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::receiveLimit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>limit</em> = <code>1</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set thr receive limit. </p>
</div>
</div>
<a class="anchor" id="a20b144ed2110e3b1c597875aa44be6df"></a><!-- doxytag: member="ost::Socket::receiveTimeout" ref="a20b144ed2110e3b1c597875aa44be6df" args="(timeout_t timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::receiveTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive timeout for receiving raw network data. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errSuccess if set. </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a20ad4739d705c429a9eb5388e4a3bccf"></a><!-- doxytag: member="ost::Socket::sendBuffer" ref="a20ad4739d705c429a9eb5388e4a3bccf" args="(unsigned size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::sendBuffer </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the protocol stack network kernel send buffer size associated with the socket. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errSuccess on success, or error. </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a101d527767089e3df6d8cbff84829791"></a><!-- doxytag: member="ost::Socket::sendLimit" ref="a101d527767089e3df6d8cbff84829791" args="(int limit=2048)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::sendLimit </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>limit</em> = <code>2048</code></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the send limit. </p>
</div>
</div>
<a class="anchor" id="ae7db59127b8297729d668d4eeed8ccab"></a><!-- doxytag: member="ost::Socket::sendTimeout" ref="ae7db59127b8297729d668d4eeed8ccab" args="(timeout_t timer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::sendTimeout </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timer</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the send timeout for sending raw network data. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>errSuccess if set. </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1a507041ee5741bcdc906707b1735781"></a><!-- doxytag: member="ost::Socket::setBroadcast" ref="a1a507041ee5741bcdc906707b1735781" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setBroadcast </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the subnet broadcast flag for the socket. </p>
<p>This enables sending to a subnet and may require special image privileges depending on the operating system.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#a86e9e41d05629a5e6f3029ace0d55e38">ost::UDPTransmit</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01217">ost::UDPTransmit::setBroadcast()</a>.</p>
</div>
</div>
<a class="anchor" id="a16eb72794ce956b2af6b935eb59b2e24"></a><!-- doxytag: member="ost::Socket::setCompletion" ref="a16eb72794ce956b2af6b935eb59b2e24" args="(bool immediate)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Socket::setCompletion </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>immediate</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to specify blocking mode for the socket. </p>
<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><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>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="tcpservice_8cpp-example.html#a7">tcpservice.cpp</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6f54a68eab25ab41bbe13ba87a48b435"></a><!-- doxytag: member="ost::Socket::setError" ref="a6f54a68eab25ab41bbe13ba87a48b435" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::Socket::setError </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a866263b2933c0b7b649829f07ca288ff"></a><!-- doxytag: member="ost::Socket::setKeepAlive" ref="a866263b2933c0b7b649829f07ca288ff" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setKeepAlive </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the keep-alive status of this socket and if keep-alive messages will be sent. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success. </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8a7b1c8f4735ffb2c8e7248e4bf37ef3"></a><!-- doxytag: member="ost::Socket::setLinger" ref="a8a7b1c8f4735ffb2c8e7248e4bf37ef3" args="(bool linger)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setLinger </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>linger</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable lingering sockets on close. </p>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a08683bc57bede572b8effb07a3fc68dc"></a><!-- doxytag: member="ost::Socket::setLoopbackByFamily" ref="a08683bc57bede572b8effb07a3fc68dc" args="(bool enable, Family family=IPV4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setLoopbackByFamily </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the multicast loopback flag for the socket. </p>
<p>Loopback enables a socket to hear what it is sending.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Referenced by <a class="el" href="socket_8h_source.html#l00937">ost::UDPSocket::setLoopback()</a>.</p>
</div>
</div>
<a class="anchor" id="a09b396c3fc7316061a3f0539e918a43f"></a><!-- doxytag: member="ost::Socket::setMulticastByFamily" ref="a09b396c3fc7316061a3f0539e918a43f" args="(bool enable, Family family=IPV4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setMulticastByFamily </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>family</em> = <code>IPV4</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. </p>
<p>It is also used as a check flag to make sure multicast is enabled before multicast operations are used.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01282">ost::UDPReceive::setMulticast()</a>, <a class="el" href="socket_8h_source.html#l01182">ost::UDPTransmit::setMulticast()</a>, and <a class="el" href="socket_8h_source.html#l00943">ost::UDPSocket::setMulticast()</a>.</p>
</div>
</div>
<a class="anchor" id="aa2c47291cf56762847cf82edfc63e473"></a><!-- doxytag: member="ost::Socket::setNoDelay" ref="aa2c47291cf56762847cf82edfc63e473" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setNoDelay </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable/disable delaying packets (Nagle algorithm). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success. </dd></dl>
<dl><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>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2165fdf85e39e6a8aaff3da889ae7e20"></a><!-- doxytag: member="ost::Socket::setRouting" ref="a2165fdf85e39e6a8aaff3da889ae7e20" args="(bool enable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setRouting </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>enable</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#a04ebd34e6cfc70146bfe3789c31d8903">ost::UDPTransmit</a>, and <a class="el" href="classost_1_1_u_d_p_receive.html#ae28ec2a16ac42d1a14f015ca5daa260f">ost::UDPReceive</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01279">ost::UDPReceive::setRouting()</a>, and <a class="el" href="socket_8h_source.html#l01211">ost::UDPTransmit::setRouting()</a>.</p>
</div>
</div>
<a class="anchor" id="a23d69227150ae996caf76b01024c1b20"></a><!-- doxytag: member="ost::Socket::setTimeToLiveByFamily" ref="a23d69227150ae996caf76b01024c1b20" args="(unsigned char ttl, Family fam=IPV4)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setTimeToLiveByFamily </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>ttl</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a36a69681caa020f1abed34ae71d206ef">Family</a> </td>
<td class="paramname"> <em>fam</em> = <code>IPV4</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the multicast time to live for a multicast socket. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 (errSuccess) on success, else error code. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01185">ost::UDPTransmit::setTimeToLive()</a>, and <a class="el" href="socket_8h_source.html#l00949">ost::UDPSocket::setTimeToLive()</a>.</p>
</div>
</div>
<a class="anchor" id="ae49df7e3c3913147116d8491f77a1b63"></a><!-- doxytag: member="ost::Socket::setTypeOfService" ref="ae49df7e3c3913147116d8491f77a1b63" args="(Tos service)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ae056b6dd4f167163083b7ab602fd3f3f">Error</a> ost::Socket::setTypeOfService </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#a258f81f5a42d051242f0f49f8192f890">Tos</a> </td>
<td class="paramname"> <em>service</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set packet scheduling on platforms which support ip quality of service conventions. </p>
<p>This effects how packets in the queue are scheduled through the interface.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, error code on failure. </dd></dl>
<dl><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>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classost_1_1_u_d_p_transmit.html#a11c5788901bb8c18af8428efe9c54145">ost::UDPTransmit</a>.</p>
<p>Referenced by <a class="el" href="socket_8h_source.html#l01214">ost::UDPTransmit::setTypeOfService()</a>.</p>
</div>
</div>
<a class="anchor" id="ae81f041407f05517bc1a8b30896965f3"></a><!-- doxytag: member="ost::Socket::writeData" ref="ae81f041407f05517bc1a8b30896965f3" args="(const void *buf, size_t len, timeout_t t=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ssize_t ost::Socket::writeData </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>len</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>t</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write a block of len bytes to socket. </p>
<dl><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>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes actually written. </dd></dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a15cb7666fe8982dc64e01354ac48dac4"></a><!-- doxytag: member="ost::Socket::dupSocket" ref="a15cb7666fe8982dc64e01354ac48dac4" args="(SOCKET s, Socket::State state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> dupSocket </td>
<td>(</td>
<td class="paramtype"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> </td>
<td class="paramname"> <em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">Socket::State</a> </td>
<td class="paramname"> <em>state</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a2b6b25a155d401b661d62eef57754bfa"></a><!-- doxytag: member="ost::Socket::broadcast" ref="a2b6b25a155d401b661d62eef57754bfa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a2b6b25a155d401b661d62eef57754bfa">ost::Socket::broadcast</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af1ef1afa83f77869dc56910ff289d0c5"></a><!-- doxytag: member="ost::Socket::completion" ref="af1ef1afa83f77869dc56910ff289d0c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#af1ef1afa83f77869dc56910ff289d0c5">ost::Socket::completion</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a335f1e849c2adb77955b896ebef1bba2"></a><!-- doxytag: member="ost::Socket::flags" ref="a335f1e849c2adb77955b896ebef1bba2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct { ... } <a class="el" href="classost_1_1_socket.html#a335f1e849c2adb77955b896ebef1bba2">ost::Socket::flags</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a507d2a060e03c63bbdf0599ffa9d555a"></a><!-- doxytag: member="ost::Socket::keepalive" ref="a507d2a060e03c63bbdf0599ffa9d555a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a507d2a060e03c63bbdf0599ffa9d555a">ost::Socket::keepalive</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a617e01f010e15ec81be466052a5a378e"></a><!-- doxytag: member="ost::Socket::linger" ref="a617e01f010e15ec81be466052a5a378e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a617e01f010e15ec81be466052a5a378e">ost::Socket::linger</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a19604a7ca524f3ee4c7623c7c237ff69"></a><!-- doxytag: member="ost::Socket::loopback" ref="a19604a7ca524f3ee4c7623c7c237ff69" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a19604a7ca524f3ee4c7623c7c237ff69">ost::Socket::loopback</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a85db9df29af07929253387d76c59ab2b"></a><!-- doxytag: member="ost::Socket::multicast" ref="a85db9df29af07929253387d76c59ab2b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a85db9df29af07929253387d76c59ab2b">ost::Socket::multicast</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a795099d3d68f4c3bf7731f263cbd1ace"></a><!-- doxytag: member="ost::Socket::mutex" ref="a795099d3d68f4c3bf7731f263cbd1ace" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_mutex.html">Mutex</a> <a class="el" href="classost_1_1_socket.html#a795099d3d68f4c3bf7731f263cbd1ace">ost::Socket::mutex</a><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a118af6ea8eba44a8dbe687f2d31a9022"></a><!-- doxytag: member="ost::Socket::route" ref="a118af6ea8eba44a8dbe687f2d31a9022" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a118af6ea8eba44a8dbe687f2d31a9022">ost::Socket::route</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af1291caf47c2e2e72a3214e4da206b07"></a><!-- doxytag: member="ost::Socket::so" ref="af1291caf47c2e2e72a3214e4da206b07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="socket_8h.html#a8dc8083897335125630f1af5dafd5831">SOCKET</a> volatile <a class="el" href="classost_1_1_socket.html#af1291caf47c2e2e72a3214e4da206b07">ost::Socket::so</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the actual socket descriptor, in Windows, unlike posix it *cannot* be used as an file descriptor that way madness lies -- jfc </p>
</div>
</div>
<a class="anchor" id="a72526c7c326a7faa20e96e9be01981ba"></a><!-- doxytag: member="ost::Socket::state" ref="a72526c7c326a7faa20e96e9be01981ba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_socket.html#ad17e0a386f4c50a57db3bebe55571066">State</a> volatile <a class="el" href="classost_1_1_socket.html#a72526c7c326a7faa20e96e9be01981ba">ost::Socket::state</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9ade0c61ad6d9b0d27c71497b6e68bd5"></a><!-- doxytag: member="ost::Socket::thrown" ref="a9ade0c61ad6d9b0d27c71497b6e68bd5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_socket.html#a9ade0c61ad6d9b0d27c71497b6e68bd5">ost::Socket::thrown</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6adc7a5d594ab3b8bace496f7a6757e9"></a><!-- doxytag: member="ost::Socket::ttl" ref="a6adc7a5d594ab3b8bace496f7a6757e9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned <a class="el" href="classost_1_1_socket.html#a6adc7a5d594ab3b8bace496f7a6757e9">ost::Socket::ttl</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
