<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceflexiport.html">flexiport</a>::<a class="el" href="classflexiport_1_1TCPPort.html">TCPPort</a>
</div>
</div>
<div class="contents">
<h1>flexiport::TCPPort Class Reference</h1><!-- doxytag: class="flexiport::TCPPort" --><!-- doxytag: inherits="flexiport::Port" -->
<p>TCP implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="tcpport_8h_source.html">tcpport.h</a>></code></p>
<p>Inherits <a class="el" href="classflexiport_1_1Port.html">flexiport::Port</a>.</p>
<p><a href="classflexiport_1_1TCPPort-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#ac34a0884e36f987337218d11ea2ed565">Open</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open the port. <a href="#ac34a0884e36f987337218d11ea2ed565"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d0c6c129794f45a1c3dc2895bef3312"></a><!-- doxytag: member="flexiport::TCPPort::Close" ref="a3d0c6c129794f45a1c3dc2895bef3312" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a3d0c6c129794f45a1c3dc2895bef3312">Close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21a4e8d56898d8481b70c6c9713f2417"></a><!-- doxytag: member="flexiport::TCPPort::Read" ref="a21a4e8d56898d8481b70c6c9713f2417" args="(void *const buffer, size_t count)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a21a4e8d56898d8481b70c6c9713f2417">Read</a> (void *const buffer, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read from the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76eb4827bc6d3c245f5d05179941ab93"></a><!-- doxytag: member="flexiport::TCPPort::ReadFull" ref="a76eb4827bc6d3c245f5d05179941ab93" args="(void *const buffer, size_t count)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a76eb4827bc6d3c245f5d05179941ab93">ReadFull</a> (void *const buffer, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the requested quantity of data from the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa2ff5ec42124404cac21ad5e99ff031f"></a><!-- doxytag: member="flexiport::TCPPort::BytesAvailable" ref="aa2ff5ec42124404cac21ad5e99ff031f" args="()" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#aa2ff5ec42124404cac21ad5e99ff031f">BytesAvailable</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes waiting to be read at the port. Returns immediatly. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab36d65613ffd037a3e685bb3bf28cdf6"></a><!-- doxytag: member="flexiport::TCPPort::BytesAvailableWait" ref="ab36d65613ffd037a3e685bb3bf28cdf6" args="()" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#ab36d65613ffd037a3e685bb3bf28cdf6">BytesAvailableWait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of bytes waiting after blocking for the timeout. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6139d8477a6d82938f262c46db80734"></a><!-- doxytag: member="flexiport::TCPPort::Write" ref="af6139d8477a6d82938f262c46db80734" args="(const void *const buffer, size_t count)" -->
ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#af6139d8477a6d82938f262c46db80734">Write</a> (const void *const buffer, size_t count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write data to the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4447d0c7950cda94023ce7ae45744b57"></a><!-- doxytag: member="flexiport::TCPPort::Flush" ref="a4447d0c7950cda94023ce7ae45744b57" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a4447d0c7950cda94023ce7ae45744b57">Flush</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the port's input and output buffers, discarding all data. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79b943f36c973d509d8c28042117ad6b"></a><!-- doxytag: member="flexiport::TCPPort::Drain" ref="a79b943f36c973d509d8c28042117ad6b" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a79b943f36c973d509d8c28042117ad6b">Drain</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Drain the port's input and output buffers. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1f0ca5662586fb6d3cac1de5c62f521"></a><!-- doxytag: member="flexiport::TCPPort::GetStatus" ref="ae1f0ca5662586fb6d3cac1de5c62f521" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#ae1f0ca5662586fb6d3cac1de5c62f521">GetStatus</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the status of the port (type, device, etc). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7390cfd0016ce83a285dd42d8a25d58"></a><!-- doxytag: member="flexiport::TCPPort::SetTimeout" ref="aa7390cfd0016ce83a285dd42d8a25d58" args="(Timeout timeout)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#aa7390cfd0016ce83a285dd42d8a25d58">SetTimeout</a> (<a class="el" href="classflexiport_1_1Timeout.html">Timeout</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the timeout value in milliseconds. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a52abfe0150e2460592367610a331ceea"></a><!-- doxytag: member="flexiport::TCPPort::SetCanRead" ref="a52abfe0150e2460592367610a331ceea" args="(bool canRead)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a52abfe0150e2460592367610a331ceea">SetCanRead</a> (bool canRead)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the read permissions of the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a370f8273d2d72f66884d6411e0d6e1b4"></a><!-- doxytag: member="flexiport::TCPPort::SetCanWrite" ref="a370f8273d2d72f66884d6411e0d6e1b4" args="(bool canWrite)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a370f8273d2d72f66884d6411e0d6e1b4">SetCanWrite</a> (bool canWrite)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the write permissions of the port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f6aaf370f2dd08710bd4f610c68bdc3"></a><!-- doxytag: member="flexiport::TCPPort::IsOpen" ref="a8f6aaf370f2dd08710bd4f610c68bdc3" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classflexiport_1_1TCPPort.html#a8f6aaf370f2dd08710bd4f610c68bdc3">IsOpen</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the port is open. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>TCP implementation of the <a class="el" href="classflexiport_1_1Port.html">Port</a> class. </p>
<p>See the <a class="el" href="classflexiport_1_1Port.html">Port</a> class documentation for how to use the common API.</p>
<dl class="user"><dt><b>Options</b></dt><dd><ul>
<li>ip <string><ul>
<li>IP address to connect to. If listen is true, set to "*" to listen on any interface.</li>
<li>Default: 127.0.0.1</li>
</ul>
</li>
<li>port <integer><ul>
<li>TCP port to connect to/listen on.</li>
<li>Default: 20000</li>
</ul>
</li>
<li>listen<ul>
<li>Listen on the specified port rather than connecting to it. Other network applications can connect and send data, which will become available as normal.</li>
<li>Default: off </li>
</ul>
</li>
</ul>
</dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac34a0884e36f987337218d11ea2ed565"></a><!-- doxytag: member="flexiport::TCPPort::Open" ref="ac34a0884e36f987337218d11ea2ed565" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void flexiport::TCPPort::Open </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open the port. </p>
<p>For a listening port, this will call accept() and therefore cause the calling process to block until an incoming connection. </p>
<p>Implements <a class="el" href="classflexiport_1_1Port.html#a8c58be7e0aa0ee292ab47501520ff870">flexiport::Port</a>.</p>
<p>Referenced by <a class="el" href="tcpport_8cpp_source.html#l00206">Read()</a>, and <a class="el" href="tcpport_8cpp_source.html#l00282">ReadFull()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="tcpport_8h_source.html">tcpport.h</a></li>
<li>tcpport.cpp</li>
</ul>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
