<!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>mrpt::utils::CServerTCPSocket Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a> </li>
<li class="navelem"><a class="el" href="namespacemrpt_1_1utils.html">utils</a> </li>
<li class="navelem"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html">CServerTCPSocket</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">mrpt::utils::CServerTCPSocket Class Reference<div class="ingroups"><a class="el" href="group__network__grp.html">Networking, sockets, DNS</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::utils::CServerTCPSocket" --><!-- doxytag: inherits="mrpt::utils::CDebugOutputCapable" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A TCP socket that can be wait for client connections to enter. </p>
<p>Unless otherwise noticed, operations are blocking. </p>
</div>
<p><code>#include <<a class="el" href="_c_server_t_c_p_socket_8h_source.html">mrpt/utils/CServerTCPSocket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::CServerTCPSocket:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1utils_1_1_c_server_t_c_p_socket__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_c_server_t_c_p_socket_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_c_server_t_c_p_socket_inherit__map" id="mrpt_1_1utils_1_1_c_server_t_c_p_socket_inherit__map">
<area shape="rect" id="node2" href="classmrpt_1_1utils_1_1_c_debug_output_capable.html" title="This base class provides a common printf-like method to send debug information to std::cout..." alt="" coords="5,5,227,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a428ab975f78fddfc11f7e17b5a6847a2">CServerTCPSocket</a> (unsigned short listenPort, const <a class="el" href="classstd_1_1string.html">std::string</a> &IPaddress=<a class="el" href="classstd_1_1string.html">std::string</a>("127.0.0.1"), int maxConnectionsWaiting=50, bool verbose=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that creates the socket, performs binding, and start listening mode. <a href="#a428ab975f78fddfc11f7e17b5a6847a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#aec0129a423bdf33e19b688b0631649d3">~CServerTCPSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aec0129a423bdf33e19b688b0631649d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a5246835c3e34d59feff90477cb29b628">isListening</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the socket was successfully open and it's bound to the desired port. <a href="#a5246835c3e34d59feff90477cb29b628"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html">CClientTCPSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a302e37f8712d0e39a6659643bb50c89b">accept</a> (int timeout_ms=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for an incoming connection (indefinitely, or with a given timeout) The returned object represents the new connection, and MUST BE deleted by the user when no longer needed. <a href="#a302e37f8712d0e39a6659643bb50c89b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_debug_output_capable.html#ab78281b5d70d6e295a8527a10fea66de">printf_debug</a> (const char *frmt,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a formated text to "debugOut" if not NULL, or to cout otherwise. <a href="#ab78281b5d70d6e295a8527a10fea66de"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classstd_1_1string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a1cfa7dbbb89d61a65744ff8bbd29bfd9">getLastErrorStr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a description of the last error. <a href="#a1cfa7dbbb89d61a65744ff8bbd29bfd9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a21768c6eab20f90e135677f61c2b4f5c">setupSocket</a> (unsigned short listenPort, const <a class="el" href="classstd_1_1string.html">std::string</a> &IPaddress, int maxConnectionsWaiting)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Common code called from the platform-dependant constructor. <a href="#a21768c6eab20f90e135677f61c2b4f5c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a726fb5c80115be178290de4b2289c899">m_serverSock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The handle for the listening server TCP socket. <a href="#a726fb5c80115be178290de4b2289c899"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a8971807b01bce89983e7fb936741e1c2">m_verbose</a></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a428ab975f78fddfc11f7e17b5a6847a2"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::CServerTCPSocket" ref="a428ab975f78fddfc11f7e17b5a6847a2" args="(unsigned short listenPort, const std::string &IPaddress=std::string("127.0.0.1"), int maxConnectionsWaiting=50, bool verbose=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CServerTCPSocket::CServerTCPSocket </td>
<td>(</td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>listenPort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>IPaddress</em> = <code><a class="el" href="classstd_1_1string.html">std::string</a>("127.0.0.1")</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxConnectionsWaiting</em> = <code>50</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>verbose</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor that creates the socket, performs binding, and start listening mode. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listenPort</td><td>The port to bound to. </td></tr>
<tr><td class="paramname">IPaddress</td><td>The interface to bound the socket to. By default 127.0.0.1 implies listening at all network interfaces. </td></tr>
<tr><td class="paramname">maxConnectionsWaiting</td><td>Maximum number of incoming connections waiting for "accept" before new ones are rejected. </td></tr>
<tr><td class="paramname">verbose</td><td>Whether to dump state information to the output defined in the <a class="el" href="classmrpt_1_1utils_1_1_c_debug_output_capable.html" title="This base class provides a common printf-like method to send debug information to std::cout...">utils::CDebugOutputCapable</a> interface. You can check if the socket has been created OK with "isListening". </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a5246835c3e34d59feff90477cb29b628" title="Returns true if the socket was successfully open and it's bound to the desired port.">isListening</a> </dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a></td><td>If there is any error creating the socket, with a textual description of the error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aec0129a423bdf33e19b688b0631649d3"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::~CServerTCPSocket" ref="aec0129a423bdf33e19b688b0631649d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CServerTCPSocket::~CServerTCPSocket </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a302e37f8712d0e39a6659643bb50c89b"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::accept" ref="a302e37f8712d0e39a6659643bb50c89b" args="(int timeout_ms=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html">CClientTCPSocket</a>* mrpt::utils::CServerTCPSocket::accept </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeout_ms</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for an incoming connection (indefinitely, or with a given timeout) The returned object represents the new connection, and MUST BE deleted by the user when no longer needed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">timeout_ms</td><td>The timeout for the waiting, in milliseconds. Set this to "-1" to disable timeout (i.e. timeout=infinite) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The incoming connection, or NULL on timeout or error. </dd></dl>
</div>
</div>
<a class="anchor" id="a1cfa7dbbb89d61a65744ff8bbd29bfd9"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::getLastErrorStr" ref="a1cfa7dbbb89d61a65744ff8bbd29bfd9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classstd_1_1string.html">std::string</a> mrpt::utils::CServerTCPSocket::getLastErrorStr </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a description of the last error. </p>
</div>
</div>
<a class="anchor" id="a5246835c3e34d59feff90477cb29b628"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::isListening" ref="a5246835c3e34d59feff90477cb29b628" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CServerTCPSocket::isListening </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the socket was successfully open and it's bound to the desired port. </p>
</div>
</div>
<a class="anchor" id="ab78281b5d70d6e295a8527a10fea66de"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::printf_debug" ref="ab78281b5d70d6e295a8527a10fea66de" args="(const char *frmt,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void mrpt::utils::CDebugOutputCapable::printf_debug </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>frmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends a formated text to "debugOut" if not NULL, or to cout otherwise. </p>
<p>Referenced by <a class="el" href="_c_levenberg_marquardt_8h_source.html#l00098">mrpt::math::CLevenbergMarquardtTempl::execute()</a>.</p>
</div>
</div>
<a class="anchor" id="a21768c6eab20f90e135677f61c2b4f5c"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::setupSocket" ref="a21768c6eab20f90e135677f61c2b4f5c" args="(unsigned short listenPort, const std::string &IPaddress, int maxConnectionsWaiting)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CServerTCPSocket::setupSocket </td>
<td>(</td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>listenPort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>IPaddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maxConnectionsWaiting</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Common code called from the platform-dependant constructor. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a726fb5c80115be178290de4b2289c899"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::m_serverSock" ref="a726fb5c80115be178290de4b2289c899" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a726fb5c80115be178290de4b2289c899">mrpt::utils::CServerTCPSocket::m_serverSock</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The handle for the listening server TCP socket. </p>
<p>Definition at line <a class="el" href="_c_server_t_c_p_socket_8h_source.html#l00058">58</a> of file <a class="el" href="_c_server_t_c_p_socket_8h_source.html">CServerTCPSocket.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8971807b01bce89983e7fb936741e1c2"></a><!-- doxytag: member="mrpt::utils::CServerTCPSocket::m_verbose" ref="a8971807b01bce89983e7fb936741e1c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html#a8971807b01bce89983e7fb936741e1c2">mrpt::utils::CServerTCPSocket::m_verbose</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_server_t_c_p_socket_8h_source.html#l00064">64</a> of file <a class="el" href="_c_server_t_c_p_socket_8h_source.html">CServerTCPSocket.h</a>.</p>
</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
