<!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>CClientTCPSocket.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CClientTCPSocket.h</div> </div>
</div>
<div class="contents">
<a href="_c_client_t_c_p_socket_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CClientTCPSocket_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CClientTCPSocket_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <mrpt/config.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="os_8h.html">mrpt/system/os.h</a>></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <<a class="code" href="_c_stream_8h.html">mrpt/utils/CStream.h</a>></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>mrpt
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">namespace </span>utils
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">class </span>CServerTCPSocket;
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="namespacemrpt_1_1utils.html#a1b6fb1ac8527aefbfa00af3c227d7f17">CMessage</a>;
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment"> /** \defgroup network_grp Networking, sockets, DNS</span>
<a name="l00044"></a>00044 <span class="comment"> * \ingroup mrpt_base_grp */</span>
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment"> /** A TCP socket that can be connected to a TCP server, implementing MRPT's CStream interface for passing objects as well as generic read/write methods.</span>
<a name="l00047"></a>00047 <span class="comment"> * Unless otherwise noticed, operations are blocking.</span>
<a name="l00048"></a>00048 <span class="comment"> *</span>
<a name="l00049"></a>00049 <span class="comment"> * Note that for convenience, DNS lookup is performed with a timeout (default=3000ms), which can be changed by the static member CClientTCPSocket::DNS_LOOKUP_TIMEOUT_MS</span>
<a name="l00050"></a>00050 <span class="comment"> * \ingroup network_grp</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> CClientTCPSocket : <span class="keyword">public</span> <a class="code" href="namespacemrpt_1_1utils.html#a4aa6d0388c837d159ca801e48d601449">CStream</a>
<a name="l00053"></a>00053 {
<a name="l00054"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acac2951fab9597c1d35eebd58d559ee6">00054</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html" title="A TCP socket that can be wait for client connections to enter.">CServerTCPSocket</a>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment"> /** See description of CClientTCPSocket */</span>
<a name="l00058"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acc5ca226a499cf4766841959c52bbca1">00058</a> <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acc5ca226a499cf4766841959c52bbca1" title="See description of CClientTCPSocket.">DNS_LOOKUP_TIMEOUT_MS</a>;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">protected</span>:
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="preprocessor">#ifdef MRPT_OS_WINDOWS</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="comment"> /** The handle for the connected TCP socket, or INVALID_SOCKET</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <span class="preprocessor"># if MRPT_WORD_SIZE==64</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span> uint64_t m_hSock;
<a name="l00067"></a>00067 <span class="preprocessor"># else</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span> uint32_t m_hSock;
<a name="l00069"></a>00069 <span class="preprocessor"># endif</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00072"></a>00072 <span class="comment"> /** The handle for the connected TCP socket, or -1</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a6518ebf1b362fb5d22dc4aeb6391c0e6">00074</a> <span class="keywordtype">int</span> <a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a6518ebf1b362fb5d22dc4aeb6391c0e6" title="The handle for the connected TCP socket, or -1.">m_hSock</a>;
<a name="l00075"></a>00075 <span class="preprocessor">#endif</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** The IP address of the remote part of the connection.</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a0f753a8b4ace57b96aceb246ebaf2604">00079</a> std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> <a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a0f753a8b4ace57b96aceb246ebaf2604" title="The IP address of the remote part of the connection.">m_remotePartIP</a>;
<a name="l00080"></a>00080 <span class="comment"></span>
<a name="l00081"></a>00081 <span class="comment"> /** The TCP port of the remote part of the connection.</span>
<a name="l00082"></a>00082 <span class="comment"> */</span>
<a name="l00083"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#af6c93aaaf8f152d43be25d25f0accc7f">00083</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#af6c93aaaf8f152d43be25d25f0accc7f" title="The TCP port of the remote part of the connection.">m_remotePartPort</a>;
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** Introduces a virtual method responsible for reading from the stream (This method BLOCKS)</span>
<a name="l00087"></a>00087 <span class="comment"> * This method is implemented as a call to "readAsync" with infinite timeouts.</span>
<a name="l00088"></a>00088 <span class="comment"> * \sa readAsync</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090 <span class="keywordtype">size_t</span> Read(<span class="keywordtype">void</span> *Buffer, <span class="keywordtype">size_t</span> Count);
<a name="l00091"></a>00091 <span class="comment"></span>
<a name="l00092"></a>00092 <span class="comment"> /** Introduces a virtual method responsible for writing to the stream.</span>
<a name="l00093"></a>00093 <span class="comment"> * Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written.</span>
<a name="l00094"></a>00094 <span class="comment"> * This method is implemented as a call to "writeAsync" with infinite timeouts.</span>
<a name="l00095"></a>00095 <span class="comment"> * \sa writeAsync</span>
<a name="l00096"></a>00096 <span class="comment"> */</span>
<a name="l00097"></a>00097 <span class="keywordtype">size_t</span> Write(<span class="keyword">const</span> <span class="keywordtype">void</span> *Buffer, <span class="keywordtype">size_t</span> Count);
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /** Returns a description of the last error */</span>
<a name="l00100"></a>00100 std<a class="code" href="classstd_1_1string.html" title="STL class.">::string</a> getLastErrorStr();
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> /** Default constructor</span>
<a name="l00104"></a>00104 <span class="comment"> * \sa connect</span>
<a name="l00105"></a>00105 <span class="comment"> */</span>
<a name="l00106"></a>00106 <a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html" title="A TCP socket that can be connected to a TCP server, implementing MRPT's CStream interface for passing...">CClientTCPSocket</a>( );
<a name="l00107"></a>00107 <span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment"> /** Destructor</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 ~<a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html" title="A TCP socket that can be connected to a TCP server, implementing MRPT's CStream interface for passing...">CClientTCPSocket</a>( );
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment"> /** Establishes a connection with a remote part.</span>
<a name="l00113"></a>00113 <span class="comment"> * \param remotePartAddress This string can be a host name, like "server" or "www.mydomain.org", or an IP address "11.22.33.44".</span>
<a name="l00114"></a>00114 <span class="comment"> * \param remotePartTCPPort The port on the remote machine to connect to.</span>
<a name="l00115"></a>00115 <span class="comment"> * \param timeout_ms The timeout to wait for the connection (0: NO TIMEOUT)</span>
<a name="l00116"></a>00116 <span class="comment"> * \exception This method raises an exception if an error is found with a textual description of the error.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118 <span class="keywordtype">void</span> connect(
<a name="l00119"></a>00119 <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &remotePartAddress,
<a name="l00120"></a>00120 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> remotePartTCPPort,
<a name="l00121"></a>00121 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeout_ms = 0 );
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> /** Returns true if this objects represents a successfully connected socket.</span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a>00125 <span class="keywordtype">bool</span> isConnected();
<a name="l00126"></a>00126 <span class="comment"></span>
<a name="l00127"></a>00127 <span class="comment"> /** Closes the connection.</span>
<a name="l00128"></a>00128 <span class="comment"> */</span>
<a name="l00129"></a>00129 <span class="keywordtype">void</span> close();
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment"> /** Writes a string to the socket.</span>
<a name="l00132"></a>00132 <span class="comment"> * \exception std::exception On communication errors</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 <span class="keywordtype">void</span> sendString( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &str );
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> /** This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception</span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#afa54310012f308664d6062c8277e4d41">00138</a> uint64_t Seek(<span class="keywordtype">long</span> Offset, <a class="code" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059" title="Used in CStream::Seek.">CStream::TSeekOrigin</a> Origin = sFromBeginning)
<a name="l00139"></a>00139 {
<a name="l00140"></a>00140 <a class="code" href="mrpt__macros_8h.html#a45b840af519f33816311acdbb28d7c10">MRPT_START</a>
<a name="l00141"></a>00141 <a class="code" href="mrpt__macros_8h.html#acc2e7c5641dd177b8a1c6f2d2470c8b7" title="Can be used to avoid "not used parameters" warnings from the compiler.">MRPT_UNUSED_PARAM</a>(Offset); <a class="code" href="mrpt__macros_8h.html#acc2e7c5641dd177b8a1c6f2d2470c8b7" title="Can be used to avoid "not used parameters" warnings from the compiler.">MRPT_UNUSED_PARAM</a>(Origin);
<a name="l00142"></a>00142 <a class="code" href="mrpt__macros_8h.html#aaa3f404ea85a6575a7139f8d101370ba">THROW_EXCEPTION</a>(<span class="stringliteral">"This method has no effect in this class!"</span>);
<a name="l00143"></a>00143 <a class="code" href="mrpt__macros_8h.html#a88a917260793b56abd83ad2a0d849eb1">MRPT_END</a>
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment"> /** This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception</span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acaef8b34ca84b192032b6b1f8d0b1b90">00148</a> uint64_t getTotalBytesCount()
<a name="l00149"></a>00149 {
<a name="l00150"></a>00150 <a class="code" href="mrpt__macros_8h.html#a45b840af519f33816311acdbb28d7c10">MRPT_START</a>
<a name="l00151"></a>00151 <a class="code" href="mrpt__macros_8h.html#aaa3f404ea85a6575a7139f8d101370ba">THROW_EXCEPTION</a>(<span class="stringliteral">"This method has no effect in this class!"</span>);
<a name="l00152"></a>00152 <a class="code" href="mrpt__macros_8h.html#a88a917260793b56abd83ad2a0d849eb1">MRPT_END</a>
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154 <span class="comment"></span>
<a name="l00155"></a>00155 <span class="comment"> /** This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception</span>
<a name="l00156"></a>00156 <span class="comment"> */</span>
<a name="l00157"></a><a class="code" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a9688415f575cff4b9cd151ad2bb1d5b7">00157</a> uint64_t getPosition()
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 <a class="code" href="mrpt__macros_8h.html#a45b840af519f33816311acdbb28d7c10">MRPT_START</a>
<a name="l00160"></a>00160 <a class="code" href="mrpt__macros_8h.html#aaa3f404ea85a6575a7139f8d101370ba">THROW_EXCEPTION</a>(<span class="stringliteral">"This method has no effect in this class!"</span>);
<a name="l00161"></a>00161 <a class="code" href="mrpt__macros_8h.html#a88a917260793b56abd83ad2a0d849eb1">MRPT_END</a>
<a name="l00162"></a>00162 }
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment"> /** A method for reading from the socket with an optional timeout.</span>
<a name="l00165"></a>00165 <span class="comment"> * \param Buffer The destination of data.</span>
<a name="l00166"></a>00166 <span class="comment"> * \param Cound The number of bytes to read.</span>
<a name="l00167"></a>00167 <span class="comment"> * \param timeoutStart_ms The maximum timeout (in milliseconds) to wait for the starting of data from the other side.</span>
<a name="l00168"></a>00168 <span class="comment"> * \param timeoutBetween_ms The maximum timeout (in milliseconds) to wait for a chunk of data after a previous one.</span>
<a name="l00169"></a>00169 <span class="comment"> * Set timeout's to -1 to block until the desired number of bytes are read, or an error happens.</span>
<a name="l00170"></a>00170 <span class="comment"> * \return The number of actually read bytes.</span>
<a name="l00171"></a>00171 <span class="comment"> */</span>
<a name="l00172"></a>00172 <span class="keywordtype">size_t</span> readAsync(
<a name="l00173"></a>00173 <span class="keywordtype">void</span> *Buffer,
<a name="l00174"></a>00174 <span class="keyword">const</span> <span class="keywordtype">size_t</span> Count,
<a name="l00175"></a>00175 <span class="keyword">const</span> <span class="keywordtype">int</span> timeoutStart_ms = -1,
<a name="l00176"></a>00176 <span class="keyword">const</span> <span class="keywordtype">int</span> timeoutBetween_ms = -1);
<a name="l00177"></a>00177 <span class="comment"></span>
<a name="l00178"></a>00178 <span class="comment"> /** A method for writing to the socket with optional timeouts.</span>
<a name="l00179"></a>00179 <span class="comment"> * The method supports writing block by block as the socket allows us to write more data.</span>
<a name="l00180"></a>00180 <span class="comment"> * \param Buffer The data.</span>
<a name="l00181"></a>00181 <span class="comment"> * \param Cound The number of bytes to write.</span>
<a name="l00182"></a>00182 <span class="comment"> * \param timeout_ms The maximum timeout (in milliseconds) to wait for the socket to be available for writing (for each block).</span>
<a name="l00183"></a>00183 <span class="comment"> * Set timeout's to -1 to block until the desired number of bytes are written, or an error happens.</span>
<a name="l00184"></a>00184 <span class="comment"> * \return The number of actually written bytes.</span>
<a name="l00185"></a>00185 <span class="comment"> */</span>
<a name="l00186"></a>00186 <span class="keywordtype">size_t</span> writeAsync(
<a name="l00187"></a>00187 <span class="keyword">const</span> <span class="keywordtype">void</span> *Buffer,
<a name="l00188"></a>00188 <span class="keyword">const</span> <span class="keywordtype">size_t</span> Count,
<a name="l00189"></a>00189 <span class="keyword">const</span> <span class="keywordtype">int</span> timeout_ms = -1 );
<a name="l00190"></a>00190 <span class="comment"></span>
<a name="l00191"></a>00191 <span class="comment"> /** Send a message through the TCP stream.</span>
<a name="l00192"></a>00192 <span class="comment"> * \param outMsg The message to be shown.</span>
<a name="l00193"></a>00193 <span class="comment"> * \param timeout_ms The maximum timeout (in milliseconds) to wait for the socket in each write operation.</span>
<a name="l00194"></a>00194 <span class="comment"> * \return Returns false on any error, or true if everything goes fine.</span>
<a name="l00195"></a>00195 <span class="comment"> */</span>
<a name="l00196"></a>00196 <span class="keywordtype">bool</span> sendMessage(
<a name="l00197"></a>00197 <span class="keyword">const</span> <a class="code" href="classmrpt_1_1utils_1_1_c_message.html" title="A class that contain generic messages, that can be sent and received from a "CClientTCPSocket" object...">CMessage</a>& outMsg,
<a name="l00198"></a>00198 <span class="keyword">const</span> <span class="keywordtype">int</span> timeout_ms = -1
<a name="l00199"></a>00199 );
<a name="l00200"></a>00200 <span class="comment"></span>
<a name="l00201"></a>00201 <span class="comment"> /** Waits for an incoming message through the TCP stream.</span>
<a name="l00202"></a>00202 <span class="comment"> * \param inMsg The received message is placed here.</span>
<a name="l00203"></a>00203 <span class="comment"> * \param timeoutStart_ms The maximum timeout (in milliseconds) to wait for the starting of data from the other side.</span>
<a name="l00204"></a>00204 <span class="comment"> * \param timeoutBetween_ms The maximum timeout (in milliseconds) to wait for a chunk of data after a previous one.</span>
<a name="l00205"></a>00205 <span class="comment"> * \return Returns false on any error (or timeout), or true if everything goes fine.</span>
<a name="l00206"></a>00206 <span class="comment"> */</span>
<a name="l00207"></a>00207 <span class="keywordtype">bool</span> receiveMessage(
<a name="l00208"></a>00208 <a class="code" href="classmrpt_1_1utils_1_1_c_message.html" title="A class that contain generic messages, that can be sent and received from a "CClientTCPSocket" object...">CMessage</a>& inMsg,
<a name="l00209"></a>00209 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutStart_ms = 100,
<a name="l00210"></a>00210 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> timeoutBetween_ms = 1000
<a name="l00211"></a>00211 );
<a name="l00212"></a>00212 <span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment"> /** Return the number of bytes already in the receive queue (they can be read without waiting) */</span>
<a name="l00214"></a>00214 <span class="keywordtype">size_t</span> getReadPendingBytes();
<a name="l00215"></a>00215
<a name="l00216"></a>00216 }; <span class="comment">// End of class def.</span>
<a name="l00217"></a>00217
<a name="l00218"></a>00218 } <span class="comment">// End of namespace</span>
<a name="l00219"></a>00219 } <span class="comment">// end of namespace</span>
<a name="l00220"></a>00220 <span class="preprocessor">#endif</span>
</pre></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>
