<!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::CClientTCPSocket 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_client_t_c_p_socket.html">CClientTCPSocket</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">mrpt::utils::CClientTCPSocket 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::CClientTCPSocket" --><!-- doxytag: inherits="mrpt::utils::CStream" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A TCP socket that can be connected to a TCP server, implementing MRPT's <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">CStream</a> interface for passing objects as well as generic read/write methods. </p>
<p>Unless otherwise noticed, operations are blocking.</p>
<p>Note that for convenience, DNS lookup is performed with a timeout (default=3000ms), which can be changed by the static member <a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acc5ca226a499cf4766841959c52bbca1" title="See description of CClientTCPSocket.">CClientTCPSocket::DNS_LOOKUP_TIMEOUT_MS</a> </p>
</div>
<p><code>#include <<a class="el" href="_c_client_t_c_p_socket_8h_source.html">mrpt/utils/CClientTCPSocket.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mrpt::utils::CClientTCPSocket:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1utils_1_1_c_client_t_c_p_socket__inherit__graph.png" border="0" usemap="#mrpt_1_1utils_1_1_c_client_t_c_p_socket_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1utils_1_1_c_client_t_c_p_socket_inherit__map" id="mrpt_1_1utils_1_1_c_client_t_c_p_socket_inherit__map">
<area shape="rect" id="node2" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv..." alt="" coords="34,5,173,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_client_t_c_p_socket-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059">TSeekOrigin</a> { <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059a41fe2275587eb7fb10ddbddd86af2beb">sFromBeginning</a> = 0,
<a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059ad45b9078d6eec3c607e7df0b7a2c66c0">sFromCurrent</a> = 1,
<a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059ad1818126a04dd7285e23554157f9f309">sFromEnd</a> = 2
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used in <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a2f3bc9d222cb31abf8d759591142fe84" title="Introduces a pure virtual method for moving to a specified position in the streamed resource...">CStream::Seek</a>. <a href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059">More...</a><br/></td></tr>
<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_client_t_c_p_socket.html#a4f2e47c0bc73eea33a795940cc667fec">CClientTCPSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a4f2e47c0bc73eea33a795940cc667fec"></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_client_t_c_p_socket.html#ae01b60c7fbad8dbfda65f190c8a14eaf">~CClientTCPSocket</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae01b60c7fbad8dbfda65f190c8a14eaf"></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_client_t_c_p_socket.html#a9a4528c704db3d89620213271d9fdd22">connect</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &remotePartAddress, unsigned short remotePartTCPPort, unsigned int timeout_ms=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Establishes a connection with a remote part. <a href="#a9a4528c704db3d89620213271d9fdd22"></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_client_t_c_p_socket.html#abdf6026773e02d552f6d38e1db19352b">isConnected</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if this objects represents a successfully connected socket. <a href="#abdf6026773e02d552f6d38e1db19352b"></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_client_t_c_p_socket.html#a7762b73fbc767adb332dd04e1dc7160a">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the connection. <a href="#a7762b73fbc767adb332dd04e1dc7160a"></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_client_t_c_p_socket.html#a9b8c151c0f6823a32e28d9df8dc86c97">sendString</a> (const <a class="el" href="classstd_1_1string.html">std::string</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to the socket. <a href="#a9b8c151c0f6823a32e28d9df8dc86c97"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#afa54310012f308664d6062c8277e4d41">Seek</a> (long Offset, <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059">CStream::TSeekOrigin</a> Origin=sFromBeginning)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception. <a href="#afa54310012f308664d6062c8277e4d41"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acaef8b34ca84b192032b6b1f8d0b1b90">getTotalBytesCount</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception. <a href="#acaef8b34ca84b192032b6b1f8d0b1b90"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a9688415f575cff4b9cd151ad2bb1d5b7">getPosition</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception. <a href="#a9688415f575cff4b9cd151ad2bb1d5b7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#ae42ed424984a7ab2d2710ef2b47522ce">readAsync</a> (void *Buffer, const size_t Count, const int timeoutStart_ms=-1, const int timeoutBetween_ms=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A method for reading from the socket with an optional timeout. <a href="#ae42ed424984a7ab2d2710ef2b47522ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a310e0f4d4f18dae31411c6251ea85a33">writeAsync</a> (const void *Buffer, const size_t Count, const int timeout_ms=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A method for writing to the socket with optional timeouts. <a href="#a310e0f4d4f18dae31411c6251ea85a33"></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_client_t_c_p_socket.html#a03446866f607687f1605f161b9f17131">sendMessage</a> (const <a class="el" href="classmrpt_1_1utils_1_1_c_message.html">CMessage</a> &outMsg, const int timeout_ms=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message through the TCP stream. <a href="#a03446866f607687f1605f161b9f17131"></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_client_t_c_p_socket.html#ae5408292e7f97484139056c95434e22e">receiveMessage</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_message.html">CMessage</a> &inMsg, const unsigned int timeoutStart_ms=100, const unsigned int timeoutBetween_ms=1000)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waits for an incoming message through the TCP stream. <a href="#ae5408292e7f97484139056c95434e22e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a85ef0039ac640279470fe94a02701616">getReadPendingBytes</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of bytes already in the receive queue (they can be read without waiting) <a href="#a85ef0039ac640279470fe94a02701616"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1b8cd3d084b5a95a3f65c6eed6e7cc6d">ReadBuffer</a> (void *Buffer, size_t Count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of bytes from the stream into Buffer </p>
<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>On any error, or if ZERO bytes are read. </td></tr>
</table>
</dd>
</dl>
<a href="#a1b8cd3d084b5a95a3f65c6eed6e7cc6d"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">size_t </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#ab3f8382b9a971abc79414464fffc7937">ReadBufferFixEndianness</a> (T *ptr, size_t ElementCount)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture. <a href="#ab3f8382b9a971abc79414464fffc7937"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aa38fe9bc49615cfae5de267903b2399b">ReadBufferImmediate</a> (void *Buffer, size_t Count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream). <a href="#aa38fe9bc49615cfae5de267903b2399b"></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_stream.html#a276005e7110c9de74ff3277b3f7bf621">WriteBuffer</a> (const void *Buffer, size_t Count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a block of bytes to the stream from Buffer. <a href="#a276005e7110c9de74ff3277b3f7bf621"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#ae229ab566ba2b9e6d2c39e32c2a9ecab">WriteBufferFixEndianness</a> (const T *ptr, size_t ElementCount)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness). <a href="#ae229ab566ba2b9e6d2c39e32c2a9ecab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a3d0bf6d8bf299f8c2bf08dc2798a525f">CopyFrom</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a> *Source, size_t Count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copies a specified number of bytes from one stream to another. <a href="#a3d0bf6d8bf299f8c2bf08dc2798a525f"></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_stream.html#aa0e9fb01aaced829b0043d50bf616c03">WriteObject</a> (const <a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> *o)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes an object to the stream. <a href="#aa0e9fb01aaced829b0043d50bf616c03"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">CSerializablePtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a290510e87656433dfd093cc31d34371c">ReadObject</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. <a href="#a290510e87656433dfd093cc31d34371c"></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_stream.html#a097cb147fd764a0fa7d86de9734fce3c">ReadObject</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> *existingObj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in. <a href="#a097cb147fd764a0fa7d86de9734fce3c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a0bbc0a924370c19c8afcd809272af0a9">operator<<</a> (const <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">CSerializablePtr</a> &pObj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write an object to a stream in the binary MRPT format. <a href="#a0bbc0a924370c19c8afcd809272af0a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1b7e00957f3d9c15b2e689a43084e592">operator<<</a> (const <a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> &obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write an object to a stream in the binary MRPT format. <a href="#a1b7e00957f3d9c15b2e689a43084e592"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a47ecf9142e139b0b48526c2792bebe99">operator>></a> (<a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">CSerializablePtr</a> &pObj)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aeb5ef746d5dc057e535f5188c5e01d74">operator>></a> (<a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> &obj)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1e02f8771e15e54157cda18fb63872a3">printf</a> (const char *fmt,...) MRPT_printf_format_check(2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a string to the stream in a textual form. <a href="#a1e02f8771e15e54157cda18fb63872a3"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">virtual int void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#ab93e0c6185c8c3b82abd067962650947">printf_vector</a> (const char *fmt, const <a class="el" href="classstd_1_1vector.html">std::vector</a>< T > &V)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints a vector in the format [A,B,C,...] using <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1e02f8771e15e54157cda18fb63872a3" title="Writes a string to the stream in a textual form.">CStream::printf</a>, and the fmt string for <b>each</b> vector element. <a href="#ab93e0c6185c8c3b82abd067962650947"></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_stream.html#a108c4d9cadd58b1ec0800c6c4816ff55">sendMessage</a> (const <a class="el" href="classmrpt_1_1utils_1_1_c_message.html">utils::CMessage</a> &msg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to the device. <a href="#a108c4d9cadd58b1ec0800c6c4816ff55"></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_stream.html#a95eb299dfa91e1d5962e2acd5bb671a6">receiveMessage</a> (<a class="el" href="classmrpt_1_1utils_1_1_c_message.html">utils::CMessage</a> &msg)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tries to receive a message from the device. <a href="#a95eb299dfa91e1d5962e2acd5bb671a6"></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_stream.html#a4e9a487df9170de72ae0ecc21bc4e867">getline</a> (<a class="el" href="classstd_1_1string.html">std::string</a> &out_str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads from the stream until a '<br/>
' character is found ('' characters are ignored). <a href="#a4e9a487df9170de72ae0ecc21bc4e867"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acc5ca226a499cf4766841959c52bbca1">DNS_LOOKUP_TIMEOUT_MS</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">See description of <a class="el" 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 href="#acc5ca226a499cf4766841959c52bbca1"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#ac9ca6b74e350f3e7b4f0619143a19462">Read</a> (void *Buffer, size_t Count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Introduces a virtual method responsible for reading from the stream (This method BLOCKS) This method is implemented as a call to "readAsync" with infinite timeouts. <a href="#ac9ca6b74e350f3e7b4f0619143a19462"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a45355081624930e3f36e49b3c0613088">Write</a> (const void *Buffer, size_t Count)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Introduces a virtual method responsible for writing to the stream. <a href="#a45355081624930e3f36e49b3c0613088"></a><br/></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_client_t_c_p_socket.html#abb9d17d0f4fbf710a77648837bfae495">getLastErrorStr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a description of the last error. <a href="#abb9d17d0f4fbf710a77648837bfae495"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected 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_client_t_c_p_socket.html#a6518ebf1b362fb5d22dc4aeb6391c0e6">m_hSock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The handle for the connected TCP socket, or -1. <a href="#a6518ebf1b362fb5d22dc4aeb6391c0e6"></a><br/></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_client_t_c_p_socket.html#a0f753a8b4ace57b96aceb246ebaf2604">m_remotePartIP</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The IP address of the remote part of the connection. <a href="#a0f753a8b4ace57b96aceb246ebaf2604"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#af6c93aaaf8f152d43be25d25f0accc7f">m_remotePartPort</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The TCP port of the remote part of the connection. <a href="#af6c93aaaf8f152d43be25d25f0accc7f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acac2951fab9597c1d35eebd58d559ee6">CServerTCPSocket</a></td></tr>
</table>
<hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="aab22931626d22c919a50183386d24059"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::TSeekOrigin" ref="aab22931626d22c919a50183386d24059" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059">mrpt::utils::CStream::TSeekOrigin</a><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used in <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a2f3bc9d222cb31abf8d759591142fe84" title="Introduces a pure virtual method for moving to a specified position in the streamed resource...">CStream::Seek</a>. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="aab22931626d22c919a50183386d24059a41fe2275587eb7fb10ddbddd86af2beb"></a><!-- doxytag: member="sFromBeginning" ref="aab22931626d22c919a50183386d24059a41fe2275587eb7fb10ddbddd86af2beb" args="" -->sFromBeginning</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aab22931626d22c919a50183386d24059ad45b9078d6eec3c607e7df0b7a2c66c0"></a><!-- doxytag: member="sFromCurrent" ref="aab22931626d22c919a50183386d24059ad45b9078d6eec3c607e7df0b7a2c66c0" args="" -->sFromCurrent</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="aab22931626d22c919a50183386d24059ad1818126a04dd7285e23554157f9f309"></a><!-- doxytag: member="sFromEnd" ref="aab22931626d22c919a50183386d24059ad1818126a04dd7285e23554157f9f309" args="" -->sFromEnd</em> </td><td>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_c_stream_8h_source.html#l00060">60</a> of file <a class="el" href="_c_stream_8h_source.html">CStream.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a4f2e47c0bc73eea33a795940cc667fec"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::CClientTCPSocket" ref="a4f2e47c0bc73eea33a795940cc667fec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CClientTCPSocket::CClientTCPSocket </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a9a4528c704db3d89620213271d9fdd22" title="Establishes a connection with a remote part.">connect</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ae01b60c7fbad8dbfda65f190c8a14eaf"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::~CClientTCPSocket" ref="ae01b60c7fbad8dbfda65f190c8a14eaf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mrpt::utils::CClientTCPSocket::~CClientTCPSocket </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="a7762b73fbc767adb332dd04e1dc7160a"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::close" ref="a7762b73fbc767adb332dd04e1dc7160a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CClientTCPSocket::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Closes the connection. </p>
</div>
</div>
<a class="anchor" id="a9a4528c704db3d89620213271d9fdd22"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::connect" ref="a9a4528c704db3d89620213271d9fdd22" args="(const std::string &remotePartAddress, unsigned short remotePartTCPPort, unsigned int timeout_ms=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CClientTCPSocket::connect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>remotePartAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short </td>
<td class="paramname"><em>remotePartTCPPort</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>timeout_ms</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Establishes a connection with a remote part. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">remotePartAddress</td><td>This string can be a host name, like "server" or "www.mydomain.org", or an IP address "11.22.33.44". </td></tr>
<tr><td class="paramname">remotePartTCPPort</td><td>The port on the remote machine to connect to. </td></tr>
<tr><td class="paramname">timeout_ms</td><td>The timeout to wait for the connection (0: NO TIMEOUT) </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname">This</td><td>method raises an exception if an error is found with a textual description of the error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a3d0bf6d8bf299f8c2bf08dc2798a525f"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::CopyFrom" ref="a3d0bf6d8bf299f8c2bf08dc2798a525f" args="(CStream *Source, size_t Count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CStream::CopyFrom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a> * </td>
<td class="paramname"><em>Source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>Count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copies a specified number of bytes from one stream to another. </p>
</div>
</div>
<a class="anchor" id="abb9d17d0f4fbf710a77648837bfae495"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::getLastErrorStr" ref="abb9d17d0f4fbf710a77648837bfae495" 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::CClientTCPSocket::getLastErrorStr </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a description of the last error. </p>
</div>
</div>
<a class="anchor" id="a4e9a487df9170de72ae0ecc21bc4e867"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::getline" ref="a4e9a487df9170de72ae0ecc21bc4e867" args="(std::string &out_str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CStream::getline </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>out_str</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads from the stream until a '<br/>
' character is found ('' characters are ignored). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false on EOF or any other read error. </dd></dl>
</div>
</div>
<a class="anchor" id="a9688415f575cff4b9cd151ad2bb1d5b7"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::getPosition" ref="a9688415f575cff4b9cd151ad2bb1d5b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t mrpt::utils::CClientTCPSocket::getPosition </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception. </p>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a4b7674b79b6c69683c30bc9e7302c88f">mrpt::utils::CStream</a>.</p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00157">157</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
<p>References <a class="el" href="mrpt__macros_8h_source.html#l00370">MRPT_START</a>, <a class="el" href="mrpt__macros_8h_source.html#l00131">THROW_EXCEPTION</a>, and <a class="el" href="mrpt__macros_8h_source.html#l00374">MRPT_END</a>.</p>
</div>
</div>
<a class="anchor" id="a85ef0039ac640279470fe94a02701616"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::getReadPendingBytes" ref="a85ef0039ac640279470fe94a02701616" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CClientTCPSocket::getReadPendingBytes </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of bytes already in the receive queue (they can be read without waiting) </p>
</div>
</div>
<a class="anchor" id="acaef8b34ca84b192032b6b1f8d0b1b90"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::getTotalBytesCount" ref="acaef8b34ca84b192032b6b1f8d0b1b90" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t mrpt::utils::CClientTCPSocket::getTotalBytesCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception. </p>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a86ad2f8a14100b0d793bbf88d4b6f3c1">mrpt::utils::CStream</a>.</p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00148">148</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
<p>References <a class="el" href="mrpt__macros_8h_source.html#l00370">MRPT_START</a>, <a class="el" href="mrpt__macros_8h_source.html#l00131">THROW_EXCEPTION</a>, and <a class="el" href="mrpt__macros_8h_source.html#l00374">MRPT_END</a>.</p>
</div>
</div>
<a class="anchor" id="abdf6026773e02d552f6d38e1db19352b"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::isConnected" ref="abdf6026773e02d552f6d38e1db19352b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CClientTCPSocket::isConnected </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if this objects represents a successfully connected socket. </p>
</div>
</div>
<a class="anchor" id="a0bbc0a924370c19c8afcd809272af0a9"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::operator<<" ref="a0bbc0a924370c19c8afcd809272af0a9" args="(const CSerializablePtr &pObj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a>& mrpt::utils::CStream::operator<< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">CSerializablePtr</a> & </td>
<td class="paramname"><em>pObj</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write an object to a stream in the binary MRPT format. </p>
</div>
</div>
<a class="anchor" id="a1b7e00957f3d9c15b2e689a43084e592"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::operator<<" ref="a1b7e00957f3d9c15b2e689a43084e592" args="(const CSerializable &obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a>& mrpt::utils::CStream::operator<< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write an object to a stream in the binary MRPT format. </p>
</div>
</div>
<a class="anchor" id="a47ecf9142e139b0b48526c2792bebe99"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::operator>>" ref="a47ecf9142e139b0b48526c2792bebe99" args="(CSerializablePtr &pObj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a>& mrpt::utils::CStream::operator>> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">CSerializablePtr</a> & </td>
<td class="paramname"><em>pObj</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aeb5ef746d5dc057e535f5188c5e01d74"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::operator>>" ref="aeb5ef746d5dc057e535f5188c5e01d74" args="(CSerializable &obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html">CStream</a>& mrpt::utils::CStream::operator>> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> & </td>
<td class="paramname"><em>obj</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1e02f8771e15e54157cda18fb63872a3"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::printf" ref="a1e02f8771e15e54157cda18fb63872a3" args="(const char *fmt,...) MRPT_printf_format_check(2" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int mrpt::utils::CStream::printf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</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> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string to the stream in a textual form. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_std_out_stream.html" title="This CStdOutStream derived class allow printing to standard out, normally the console text output...">CStdOutStream</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ab93e0c6185c8c3b82abd067962650947"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::printf_vector" ref="ab93e0c6185c8c3b82abd067962650947" args="(const char *fmt, const std::vector< T > &V)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">virtual int void mrpt::utils::CStream::printf_vector </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classstd_1_1vector.html">std::vector</a>< T > & </td>
<td class="paramname"><em>V</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints a vector in the format [A,B,C,...] using <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1e02f8771e15e54157cda18fb63872a3" title="Writes a string to the stream in a textual form.">CStream::printf</a>, and the fmt string for <b>each</b> vector element. </p>
<p>Definition at line <a class="el" href="_c_stream_8h_source.html#l00219">219</a> of file <a class="el" href="_c_stream_8h_source.html">CStream.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac9ca6b74e350f3e7b4f0619143a19462"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::Read" ref="ac9ca6b74e350f3e7b4f0619143a19462" args="(void *Buffer, size_t Count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CClientTCPSocket::Read </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>Count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Introduces a virtual method responsible for reading from the stream (This method BLOCKS) This method is implemented as a call to "readAsync" with infinite timeouts. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#ae42ed424984a7ab2d2710ef2b47522ce" title="A method for reading from the socket with an optional timeout.">readAsync</a> </dd></dl>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1ab0c4a0857bc41248808dc8b75d32d9">mrpt::utils::CStream</a>.</p>
</div>
</div>
<a class="anchor" id="ae42ed424984a7ab2d2710ef2b47522ce"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::readAsync" ref="ae42ed424984a7ab2d2710ef2b47522ce" args="(void *Buffer, const size_t Count, const int timeoutStart_ms=-1, const int timeoutBetween_ms=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CClientTCPSocket::readAsync </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>Count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>timeoutStart_ms</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>timeoutBetween_ms</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A method for reading from the socket with an optional timeout. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">Buffer</td><td>The destination of data. </td></tr>
<tr><td class="paramname">Cound</td><td>The number of bytes to read. </td></tr>
<tr><td class="paramname">timeoutStart_ms</td><td>The maximum timeout (in milliseconds) to wait for the starting of data from the other side. </td></tr>
<tr><td class="paramname">timeoutBetween_ms</td><td>The maximum timeout (in milliseconds) to wait for a chunk of data after a previous one. Set timeout's to -1 to block until the desired number of bytes are read, or an error happens. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of actually read bytes. </dd></dl>
</div>
</div>
<a class="anchor" id="a1b8cd3d084b5a95a3f65c6eed6e7cc6d"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::ReadBuffer" ref="a1b8cd3d084b5a95a3f65c6eed6e7cc6d" args="(void *Buffer, size_t Count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CStream::ReadBuffer </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>Count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads a block of bytes from the stream into Buffer </p>
<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>On any error, or if ZERO bytes are read. </td></tr>
</table>
</dd>
</dl>
</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amound of bytes actually read. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This method is endianness-dependent. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aa38fe9bc49615cfae5de267903b2399b" title="Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read...">ReadBufferImmediate</a> ; Important, see: <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#ab3f8382b9a971abc79414464fffc7937" title="Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream s...">ReadBufferFixEndianness</a>, </dd></dl>
</div>
</div>
<a class="anchor" id="ab3f8382b9a971abc79414464fffc7937"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::ReadBufferFixEndianness" ref="ab3f8382b9a971abc79414464fffc7937" args="(T *ptr, size_t ElementCount)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CStream::ReadBufferFixEndianness </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>ElementCount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ElementCount</td><td>The number of elements (not bytes) to read. </td></tr>
<tr><td class="paramname">ptr</td><td>A pointer to the first output element in an array (or std::vector<>, etc...). </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amound of *bytes* (not elements) actually read (under error situations, the last element may be invalid if the data stream abruptly ends). Example of usage: <div class="fragment"><pre class="fragment"> uint32_t N;
s >> N;
vector<float> vec(N);
<span class="keywordflow">if</span> (N)
s.ReadBufferFixEndianness<<span class="keywordtype">float</span>>(&vec[0],N);
</pre></div> </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>On any error, or if ZERO bytes are read. </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_stream.html#ab3f8382b9a971abc79414464fffc7937" title="Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream s...">ReadBufferFixEndianness</a>, <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1b8cd3d084b5a95a3f65c6eed6e7cc6d" title="Reads a block of bytes from the stream into Buffer On any error, or if ZERO bytes are read...">ReadBuffer</a> </dd></dl>
<p>Definition at line <a class="el" href="_c_stream_8h_source.html#l00109">109</a> of file <a class="el" href="_c_stream_8h_source.html">CStream.h</a>.</p>
<p>References <a class="el" href="bits_8h_source.html#l00172">mrpt::utils::reverseBytesInPlace()</a>.</p>
<p>Referenced by <a class="el" href="ops__vectors_8h_source.html#l00163">mrpt::math::operator>>()</a>.</p>
</div>
</div>
<a class="anchor" id="aa38fe9bc49615cfae5de267903b2399b"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::ReadBufferImmediate" ref="aa38fe9bc49615cfae5de267903b2399b" args="(void *Buffer, size_t Count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual size_t mrpt::utils::CStream::ReadBufferImmediate </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>Count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream). </p>
<p>Note that this method will fallback to <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a1b8cd3d084b5a95a3f65c6eed6e7cc6d" title="Reads a block of bytes from the stream into Buffer On any error, or if ZERO bytes are read...">ReadBuffer()</a> in most <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html" title="This base class is used to provide a unified interface to files,memory buffers,..Please see the deriv...">CStream</a> classes but in some hardware-related classes. </p>
<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>On any error, or if ZERO bytes are read. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classmrpt_1_1hwdrivers_1_1_c_interface_f_t_d_i.html#ad6585545a46cf2f851ff4a83aaf0c02d">mrpt::hwdrivers::CInterfaceFTDI</a>.</p>
<p>Definition at line <a class="el" href="_c_stream_8h_source.html#l00127">127</a> of file <a class="el" href="_c_stream_8h_source.html">CStream.h</a>.</p>
</div>
</div>
<a class="anchor" id="a290510e87656433dfd093cc31d34371c"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::ReadObject" ref="a290510e87656433dfd093cc31d34371c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structmrpt_1_1utils_1_1_c_serializable_ptr.html">CSerializablePtr</a> mrpt::utils::CStream::ReadObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. </p>
<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>On I/O error or undefined class. </td></tr>
<tr><td class="paramname"><a class="el" href="classmrpt_1_1utils_1_1_c_exception_e_o_f.html" title="Used in mrpt::utils::CStream.">mrpt::utils::CExceptionEOF</a></td><td>On an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain <a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a> instead. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="ops__matrices_8h_source.html#l00062">mrpt::math::operator>>()</a>.</p>
</div>
</div>
<a class="anchor" id="a097cb147fd764a0fa7d86de9734fce3c"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::ReadObject" ref="a097cb147fd764a0fa7d86de9734fce3c" args="(CSerializable *existingObj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CStream::ReadObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> * </td>
<td class="paramname"><em>existingObj</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in. </p>
<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>On I/O error or different class found. </td></tr>
<tr><td class="paramname"><a class="el" href="classmrpt_1_1utils_1_1_c_exception_e_o_f.html" title="Used in mrpt::utils::CStream.">mrpt::utils::CExceptionEOF</a></td><td>On an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain <a class="el" href="classstd_1_1exception.html" title="STL class.">std::exception</a> instead. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae5408292e7f97484139056c95434e22e"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::receiveMessage" ref="ae5408292e7f97484139056c95434e22e" args="(CMessage &inMsg, const unsigned int timeoutStart_ms=100, const unsigned int timeoutBetween_ms=1000)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CClientTCPSocket::receiveMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_message.html">CMessage</a> & </td>
<td class="paramname"><em>inMsg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>timeoutStart_ms</em> = <code>100</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned int </td>
<td class="paramname"><em>timeoutBetween_ms</em> = <code>1000</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Waits for an incoming message through the TCP stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">inMsg</td><td>The received message is placed here. </td></tr>
<tr><td class="paramname">timeoutStart_ms</td><td>The maximum timeout (in milliseconds) to wait for the starting of data from the other side. </td></tr>
<tr><td class="paramname">timeoutBetween_ms</td><td>The maximum timeout (in milliseconds) to wait for a chunk of data after a previous one. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns false on any error (or timeout), or true if everything goes fine. </dd></dl>
</div>
</div>
<a class="anchor" id="a95eb299dfa91e1d5962e2acd5bb671a6"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::receiveMessage" ref="a95eb299dfa91e1d5962e2acd5bb671a6" args="(utils::CMessage &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CStream::receiveMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_message.html">utils::CMessage</a> & </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tries to receive a message from the device. </p>
<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>On communication errors </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if successful, false if there is no new data from the device (but communications seem to work fine) </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>The frame <a class="el" href="namespacemrpt.html#a3a27af794b658df5491e2b7678f8ccb8" title="A std::string version of C sprintf.">format</a> is described in <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a108c4d9cadd58b1ec0800c6c4816ff55" title="Send a message to the device.">sendMessage()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="afa54310012f308664d6062c8277e4d41"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::Seek" ref="afa54310012f308664d6062c8277e4d41" args="(long Offset, CStream::TSeekOrigin Origin=sFromBeginning)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t mrpt::utils::CClientTCPSocket::Seek </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>Offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#aab22931626d22c919a50183386d24059">CStream::TSeekOrigin</a> </td>
<td class="paramname"><em>Origin</em> = <code>sFromBeginning</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This virtual method has no effect in this implementation over a TCP socket, and its use raises an exception. </p>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a2f3bc9d222cb31abf8d759591142fe84">mrpt::utils::CStream</a>.</p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00138">138</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
<p>References <a class="el" href="mrpt__macros_8h_source.html#l00370">MRPT_START</a>, <a class="el" href="mrpt__macros_8h_source.html#l00311">MRPT_UNUSED_PARAM</a>, <a class="el" href="mrpt__macros_8h_source.html#l00131">THROW_EXCEPTION</a>, and <a class="el" href="mrpt__macros_8h_source.html#l00374">MRPT_END</a>.</p>
</div>
</div>
<a class="anchor" id="a03446866f607687f1605f161b9f17131"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::sendMessage" ref="a03446866f607687f1605f161b9f17131" args="(const CMessage &outMsg, const int timeout_ms=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mrpt::utils::CClientTCPSocket::sendMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1_c_message.html">CMessage</a> & </td>
<td class="paramname"><em>outMsg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>timeout_ms</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a message through the TCP stream. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">outMsg</td><td>The message to be shown. </td></tr>
<tr><td class="paramname">timeout_ms</td><td>The maximum timeout (in milliseconds) to wait for the socket in each write operation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns false on any error, or true if everything goes fine. </dd></dl>
</div>
</div>
<a class="anchor" id="a108c4d9cadd58b1ec0800c6c4816ff55"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::sendMessage" ref="a108c4d9cadd58b1ec0800c6c4816ff55" args="(const utils::CMessage &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CStream::sendMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1_c_message.html">utils::CMessage</a> & </td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send a message to the device. </p>
<p>Note that only the low byte from the "type" field will be used.</p>
<p>For frames of size < 255 the frame format is an array of bytes in this order: </p>
<div class="fragment"><pre class="fragment"> <START_FLAG> <HEADER> <LENGTH> <BODY> <END_FLAG>
<START_FLAG> = 0x69
<HEADER> = A header byte
<LENGHT> = Number of bytes of BODY
<BODY> = N x bytes
<END_FLAG> = 0X96
Total length = <LENGTH> + 4
</pre></div><p>For frames of size > 255 the frame format is an array of bytes in this order: </p>
<div class="fragment"><pre class="fragment"> <START_FLAG> <HEADER> <HIBYTE(LENGTH)> <LOBYTE(LENGTH)> <BODY> <END_FLAG>
<START_FLAG> = 0x79
<HEADER> = A header byte
<LENGHT> = Number of bytes of BODY
<BODY> = N x bytes
<END_FLAG> = 0X96
Total length = <LENGTH> + 5
</pre></div><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>On communication errors </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9b8c151c0f6823a32e28d9df8dc86c97"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::sendString" ref="a9b8c151c0f6823a32e28d9df8dc86c97" args="(const std::string &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CClientTCPSocket::sendString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> & </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a string to the socket. </p>
<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>On communication errors </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a45355081624930e3f36e49b3c0613088"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::Write" ref="a45355081624930e3f36e49b3c0613088" args="(const void *Buffer, size_t Count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CClientTCPSocket::Write </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>Count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Introduces a virtual method responsible for writing to the stream. </p>
<p>Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written. This method is implemented as a call to "writeAsync" with infinite timeouts. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a310e0f4d4f18dae31411c6251ea85a33" title="A method for writing to the socket with optional timeouts.">writeAsync</a> </dd></dl>
<p>Implements <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#a171c27fa5b26f5486d34bcbca550cb91">mrpt::utils::CStream</a>.</p>
</div>
</div>
<a class="anchor" id="a310e0f4d4f18dae31411c6251ea85a33"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::writeAsync" ref="a310e0f4d4f18dae31411c6251ea85a33" args="(const void *Buffer, const size_t Count, const int timeout_ms=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mrpt::utils::CClientTCPSocket::writeAsync </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>Count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>timeout_ms</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A method for writing to the socket with optional timeouts. </p>
<p>The method supports writing block by block as the socket allows us to write more data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">Buffer</td><td>The data. </td></tr>
<tr><td class="paramname">Cound</td><td>The number of bytes to write. </td></tr>
<tr><td class="paramname">timeout_ms</td><td>The maximum timeout (in milliseconds) to wait for the socket to be available for writing (for each block). Set timeout's to -1 to block until the desired number of bytes are written, or an error happens. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of actually written bytes. </dd></dl>
</div>
</div>
<a class="anchor" id="a276005e7110c9de74ff3277b3f7bf621"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::WriteBuffer" ref="a276005e7110c9de74ff3277b3f7bf621" args="(const void *Buffer, size_t Count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CStream::WriteBuffer </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>Buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>Count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a block of bytes to the stream from Buffer. </p>
<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>On any error </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>Important, see: <a class="el" href="classmrpt_1_1utils_1_1_c_stream.html#ae229ab566ba2b9e6d2c39e32c2a9ecab" title="Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running arch...">WriteBufferFixEndianness</a> </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This method is endianness-dependent. </dd></dl>
</div>
</div>
<a class="anchor" id="ae229ab566ba2b9e6d2c39e32c2a9ecab"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::WriteBufferFixEndianness" ref="ae229ab566ba2b9e6d2c39e32c2a9ecab" args="(const T *ptr, size_t ElementCount)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CStream::WriteBufferFixEndianness </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>ElementCount</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness). </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">ElementCount</td><td>The number of elements (not bytes) to write. </td></tr>
<tr><td class="paramname">ptr</td><td>A pointer to the first input element in an array (or std::vector<>, etc...). Example of usage: <div class="fragment"><pre class="fragment"> vector<float> vec = ...
uint32_t N = vec.size();
s << N
<span class="keywordflow">if</span> (N)
s.WriteBufferFixEndianness<<span class="keywordtype">float</span>>(&vec[0],N);
</pre></div> </td></tr>
</table>
</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>On any error </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_stream.html#a276005e7110c9de74ff3277b3f7bf621" title="Writes a block of bytes to the stream from Buffer.">WriteBuffer</a> </dd></dl>
<p>Definition at line <a class="el" href="_c_stream_8h_source.html#l00153">153</a> of file <a class="el" href="_c_stream_8h_source.html">CStream.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa0e9fb01aaced829b0043d50bf616c03"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::WriteObject" ref="aa0e9fb01aaced829b0043d50bf616c03" args="(const CSerializable *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void mrpt::utils::CStream::WriteObject </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmrpt_1_1utils_1_1_c_serializable.html">CSerializable</a> * </td>
<td class="paramname"><em>o</em></td><td>)</td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Writes an object to the stream. </p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="acac2951fab9597c1d35eebd58d559ee6"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::CServerTCPSocket" ref="acac2951fab9597c1d35eebd58d559ee6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classmrpt_1_1utils_1_1_c_server_t_c_p_socket.html">CServerTCPSocket</a><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00054">54</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="acc5ca226a499cf4766841959c52bbca1"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::DNS_LOOKUP_TIMEOUT_MS" ref="acc5ca226a499cf4766841959c52bbca1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int <a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#acc5ca226a499cf4766841959c52bbca1">mrpt::utils::CClientTCPSocket::DNS_LOOKUP_TIMEOUT_MS</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>See description of <a class="el" 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>. </p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00058">58</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6518ebf1b362fb5d22dc4aeb6391c0e6"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::m_hSock" ref="a6518ebf1b362fb5d22dc4aeb6391c0e6" 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_client_t_c_p_socket.html#a6518ebf1b362fb5d22dc4aeb6391c0e6">mrpt::utils::CClientTCPSocket::m_hSock</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The handle for the connected TCP socket, or -1. </p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00074">74</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0f753a8b4ace57b96aceb246ebaf2604"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::m_remotePartIP" ref="a0f753a8b4ace57b96aceb246ebaf2604" 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> <a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#a0f753a8b4ace57b96aceb246ebaf2604">mrpt::utils::CClientTCPSocket::m_remotePartIP</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The IP address of the remote part of the connection. </p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00079">79</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.h</a>.</p>
</div>
</div>
<a class="anchor" id="af6c93aaaf8f152d43be25d25f0accc7f"></a><!-- doxytag: member="mrpt::utils::CClientTCPSocket::m_remotePartPort" ref="af6c93aaaf8f152d43be25d25f0accc7f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned short <a class="el" href="classmrpt_1_1utils_1_1_c_client_t_c_p_socket.html#af6c93aaaf8f152d43be25d25f0accc7f">mrpt::utils::CClientTCPSocket::m_remotePartPort</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The TCP port of the remote part of the connection. </p>
<p>Definition at line <a class="el" href="_c_client_t_c_p_socket_8h_source.html#l00083">83</a> of file <a class="el" href="_c_client_t_c_p_socket_8h_source.html">CClientTCPSocket.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>
