Click here to Skip to main content
15,892,537 members
Articles / Programming Languages / C

A Generic C-Language TCP Client Application

Rate me:
Please Sign up or sign in to vote.
3.67/5 (2 votes)
9 May 2010CPOL4 min read 29.1K   793   20  
A library for writing simple TCP client applications
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TcpClient2: Message.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</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>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>Message.h File Reference</h1>
<p>Public interface for class <a class="el" href="structMessage.html" title="Message data structure.">Message</a>.  
<a href="#_details">More...</a></p>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
<div class="center"><img src="Message_8h__dep__incl.png" border="0" usemap="#Message_8hdep_map" alt=""/></div>
<map name="Message_8hdep_map" id="Message_8hdep">
<area shape="rect" href="Client_8h.html" title="Public interface for class Client." alt="" coords="28,83,92,112"/><area shape="rect" href="Message_8c.html" title="Implementation of class Message." alt="" coords="116,83,201,112"/><area shape="rect" href="GenericClient_8c.html" title="Implementation of class GenericClient." alt="" coords="5,160,115,189"/></map>
</div>

<p><a href="Message_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structMessage.html">Message</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a82fffef6ac8d8a796ab35b7d6a7a0dcb">Message</a></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="structMessage.html">Message</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a3fbd71fce59e1ed9337447f4e58db2ed">message_create</a> (<a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#aca5526494c50cb46e9d25739d860098c" title="Creates a Message structure.">Message::message_create</a>  <a href="#a3fbd71fce59e1ed9337447f4e58db2ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a80b69855414b3327d9527d4b96b802c2">message_destroy</a> (<a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a15fe0a2ac6e5819f450862a62284e87e" title="Destroys a Message structure.">Message::message_destroy</a>  <a href="#a80b69855414b3327d9527d4b96b802c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#aaf379ce56fe66f1c234fb96fa75c64a8">message_flags</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ae523552e769bebf6d3e43a1f7fcca1f1" title="Retrieves the message flags.">Message::message_flags</a>  <a href="#aaf379ce56fe66f1c234fb96fa75c64a8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ad2f3f3fcb15603d1c2ec93967da7f47b">message_ipAddr</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a6e475725fcfec6e595c174d2b3aa56a2" title="Retrieves the IP address associated with this Message.">Message::message_ipAddr</a>  <a href="#ad2f3f3fcb15603d1c2ec93967da7f47b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a6e2560c92901098cb3cd008a79dcdeba">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a3e36335cd07843fe87db161b6b5ef9a3">message_isValidPrefix</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a8813f1306e704c9c7b59cc25b104f418" title="Checks if the Message prefix is valid.">Message::message_isValidPrefix</a>  <a href="#a3e36335cd07843fe87db161b6b5ef9a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a6e2560c92901098cb3cd008a79dcdeba">bool</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a5532aa785069586eb5cb0950bc89e630">message_isValidSuffix</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a8524606b8cb2c28dc55892ef87425f8f" title="Checks if the Message suffix is valid.">Message::message_isValidSuffix</a>  <a href="#a5532aa785069586eb5cb0950bc89e630"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ad79085024874f86561123dba96ae34ae">message_maxBodySize</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ad79085024874f86561123dba96ae34ae" title="Retrieves the value configured for the maximum data area size of a message.">Message::message_maxBodySize</a>  <a href="#ad79085024874f86561123dba96ae34ae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#aee7425cb32cff0e3aa1703ea591373af">message_prefix</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a8f0de8a9e37b91bc8f3855950a581cc9" title="Retrieves the Message prefix.">Message::message_prefix</a>  <a href="#aee7425cb32cff0e3aa1703ea591373af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ae8533d9aadc4bd5efb9232b3b76ce788">message_seqNo</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a8bd306302e7961fef5e355f991fd2070" title="Retrieves the sequence number of this Message.">Message::message_seqNo</a>  <a href="#ae8533d9aadc4bd5efb9232b3b76ce788"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ad8b7b738ecb16a51de905ff169b3ee30">message_orgId</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a02ce321c76ba95032a6894b5096893a9" title="Retrieves the source identification of this Message.">Message::message_orgId</a>  <a href="#ad8b7b738ecb16a51de905ff169b3ee30"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a2d444165c65e9e524e8e6a10eb008359">message_orgSeqNo</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a6b67b118a73c8dbcfbdf806b17812ff5" title="Retrieves the sequence number of the Message that was set by the client.">Message::message_orgSeqNo</a>  <a href="#a2d444165c65e9e524e8e6a10eb008359"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a52415b8242eb5a34b6249d8f9b0cb0f3">message_size</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a752d83635cc98231e3e5f96b0fecba24" title="Retrieves the size of the data area of this Message.">Message::message_size</a>  <a href="#a52415b8242eb5a34b6249d8f9b0cb0f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ab2c30f86b55850b3e0859fc37b9e6aa1">message_size1</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ab2c30f86b55850b3e0859fc37b9e6aa1" title="Retrieves the size of the part 1 of a Message being received.">Message::message_size1</a>  <a href="#ab2c30f86b55850b3e0859fc37b9e6aa1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a2ce7590ea639b229357b29c187c2a2f4">message_size2</a> (const <a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ae5c0beb7f40308b7f2e8477dd7f3df68" title="Retrieves the size of the part 2 of a Message being received.">Message::message_size2</a>  <a href="#a2ce7590ea639b229357b29c187c2a2f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a4bda33d4f9469e060c37f2986dd286f3">message_suffix</a> (<a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ab5c8cf6a29744dcbf5358f47235f8939" title="Retrives the message suffix.">Message::message_suffix</a>  <a href="#a4bda33d4f9469e060c37f2986dd286f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a8ce1fd41a1c00f93525c53e204946a24">message_setMaxSize</a> (<a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#aa2a4a15ffe932da3b34b3d4a989d864d" title="Configures the maximum size of the data area for all Messages .">Message::message_setMaxSize</a>  <a href="#a8ce1fd41a1c00f93525c53e204946a24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a1d5961c1e7523eacb415b37ac0202a43">message_setOrgId</a> (<a class="el" href="structMessage.html">Message</a> *dst, <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> orgId)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#aab8fc2edae92cb1126c49962fa6bf5bc" title="Sets the source identification of this Message.">Message::message_setOrgId</a>  <a href="#a1d5961c1e7523eacb415b37ac0202a43"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a7898cab691c81314107190749f4bbd1a">message_setOrgSeqNo</a> (<a class="el" href="structMessage.html">Message</a> *dst, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> <a class="el" href="classClient.html#a258ded446f21a1edd363ab196974c202">orgSeqNo</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a8e43c34b2690c17b30abb2b196a20ca1" title="Sets the local sequence number of this Message.">Message::message_setOrgSeqNo</a>  <a href="#a7898cab691c81314107190749f4bbd1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#af5c94ce74d859f8493b87d72eb686454">message_setSeqNo</a> (<a class="el" href="structMessage.html">Message</a> *dst, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> seqNo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#aa59d4c4678ad429cdc8b544da777093c" title="Sets the sequence number of this Message within its Connection.">Message::message_setSeqNo</a>  <a href="#af5c94ce74d859f8493b87d72eb686454"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ad22c674360e643cc86c86505f64dd170">message_setSize</a> (const <a class="el" href="structMessage.html">Message</a> *, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ad69731535e80de38043fff92e741767f" title="Sets the size of the Message data area.">Message::message_setSize</a>  <a href="#ad22c674360e643cc86c86505f64dd170"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a94499a4fa9fe765c867a3e66a8c337a7">message_buffer</a> (<a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#afc1b11df5974b3c9f53d6de19ae61b02" title="Retrieves the data area of a Message.">Message::message_buffer</a>  <a href="#a94499a4fa9fe765c867a3e66a8c337a7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#abd75d5c27798093d703c092bbaf40ef2">message_start</a> (<a class="el" href="structMessage.html">Message</a> *)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#ad82725c7d518ca0e3759d5aa1d517233" title="Retrieves the address of on-the-wire contents of this Message.">Message::message_start</a>  <a href="#abd75d5c27798093d703c092bbaf40ef2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API <a class="el" href="config_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ae4c123d2e5563c596eb8d2f06e986c8b">message_byte</a> (const <a class="el" href="structMessage.html">Message</a> *, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> msgOffset)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a6b008801b8bc2a446a43caddacee89c0" title="Returns one byte from the message body.">Message::message_byte</a>  <a href="#ae4c123d2e5563c596eb8d2f06e986c8b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a10b2409a2ef4eae0eaa998ddc3eac3a3">message_cloneFields</a> (<a class="el" href="structMessage.html">Message</a> *dst, const <a class="el" href="structMessage.html">Message</a> *src, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> nFields,...)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#af5a4485a9d2146fd3126e888309c06c3" title="Clones fields from one message to another.">Message::message_cloneFields</a>.  <a href="#a10b2409a2ef4eae0eaa998ddc3eac3a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a2f67cf9a2193e126598a8294030affca">message_compareToMessage</a> (<a class="el" href="config_8h.html#a0f128c3e0c83721af0220c00554e9c4e">cchar</a> *src1, const <a class="el" href="structMessage.html">Message</a> *src2, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> msgOffset, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#acdcbe1043d4114164b5302b3e6fd9f6b" title="Compares data from an application buffer with the message body.">Message::message_compareToMessage</a>  <a href="#a2f67cf9a2193e126598a8294030affca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#af9656d60f414a9f225a60e5ea0cfbf8f">message_copyFields</a> (<a class="el" href="structMessage.html">Message</a> *dst, const <a class="el" href="structMessage.html">Message</a> *src, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> nFields,...)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a20b536522e67d0127b42ee9e9e453d4b" title="Copies fields from one message to another.">Message::message_copyFields</a>.  <a href="#af9656d60f414a9f225a60e5ea0cfbf8f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a5b3afce514e90e141d489ffb33e95c12">message_copyFromMessage</a> (char *dst, const <a class="el" href="structMessage.html">Message</a> *src, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> msgOffset, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#aaa4f0b8bed37b3b8739e51c4a33af380" title="Copies data from the message body to an application buffer.">Message::message_copyFromMessage</a>  <a href="#a5b3afce514e90e141d489ffb33e95c12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#ab5c656492c5d169ddbf490d8a076138c">message_copyToMessage</a> (const <a class="el" href="structMessage.html">Message</a> *dst, <a class="el" href="config_8h.html#a0f128c3e0c83721af0220c00554e9c4e">cchar</a> *src, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> msgOffset, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#afede30937f7778cd02a2686c0535e044" title="Copies data from an application buffer to the message body.">Message::message_copyToMessage</a>  <a href="#ab5c656492c5d169ddbf490d8a076138c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a59e76138748e61fbefb799649aa2f000">message_fill</a> (const <a class="el" href="structMessage.html">Message</a> *dst, char fill, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> msgOffset, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a7a30b2e32e3a6c5ff74cf8b6d8ffde35" title="Fills message body with a character.">Message::message_fill</a>  <a href="#a59e76138748e61fbefb799649aa2f000"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TC2API void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="Message_8h.html#a6d134a41d749728e073d200e31d2a1f3">message_setByte</a> (const <a class="el" href="structMessage.html">Message</a> *dst, <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> msgOffset, <a class="el" href="config_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> byte)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">see <a class="el" href="structMessage.html#a9224f61db5310f744f52ad06649f158c" title="Sets one byte in the message body with a byte from the application.">Message::message_setByte</a>  <a href="#a6d134a41d749728e073d200e31d2a1f3"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Public interface for class <a class="el" href="structMessage.html" title="Message data structure.">Message</a>. </p>

<p>Definition in file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a82fffef6ac8d8a796ab35b7d6a7a0dcb"></a><!-- doxytag: member="Message.h::Message" ref="a82fffef6ac8d8a796ab35b7d6a7a0dcb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structMessage.html">Message</a> <a class="el" href="structMessage.html">Message</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="Message_8h_source.html#l00015">15</a> of file <a class="el" href="Message_8h_source.html">Message.h</a>.</p>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a94499a4fa9fe765c867a3e66a8c337a7"></a><!-- doxytag: member="Message.h::message_buffer" ref="a94499a4fa9fe765c867a3e66a8c337a7" args="(Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API char* message_buffer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#afc1b11df5974b3c9f53d6de19ae61b02" title="Retrieves the data area of a Message.">Message::message_buffer</a> </p>

</div>
</div>
<a class="anchor" id="ae4c123d2e5563c596eb8d2f06e986c8b"></a><!-- doxytag: member="Message.h::message_byte" ref="ae4c123d2e5563c596eb8d2f06e986c8b" args="(const Message *, ushort msgOffset)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a> message_byte </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>msgOffset</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a6b008801b8bc2a446a43caddacee89c0" title="Returns one byte from the message body.">Message::message_byte</a> </p>

</div>
</div>
<a class="anchor" id="a10b2409a2ef4eae0eaa998ddc3eac3a3"></a><!-- doxytag: member="Message.h::message_cloneFields" ref="a10b2409a2ef4eae0eaa998ddc3eac3a3" args="(Message *dst, const Message *src, ushort nFields,...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_cloneFields </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>nFields</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&nbsp;</td>
          <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#af5a4485a9d2146fd3126e888309c06c3" title="Clones fields from one message to another.">Message::message_cloneFields</a>. </p>
<p>One field: offset, size. </p>

</div>
</div>
<a class="anchor" id="a2f67cf9a2193e126598a8294030affca"></a><!-- doxytag: member="Message.h::message_compareToMessage" ref="a2f67cf9a2193e126598a8294030affca" args="(cchar *src1, const Message *src2, ushort msgOffset, ushort size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API int message_compareToMessage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="config_8h.html#a0f128c3e0c83721af0220c00554e9c4e">cchar</a> *&nbsp;</td>
          <td class="paramname"> <em>src1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>src2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>msgOffset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#acdcbe1043d4114164b5302b3e6fd9f6b" title="Compares data from an application buffer with the message body.">Message::message_compareToMessage</a> </p>

</div>
</div>
<a class="anchor" id="af9656d60f414a9f225a60e5ea0cfbf8f"></a><!-- doxytag: member="Message.h::message_copyFields" ref="af9656d60f414a9f225a60e5ea0cfbf8f" args="(Message *dst, const Message *src, ushort nFields,...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_copyFields </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>nFields</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&nbsp;</td>
          <td class="paramname"> <em>...</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a20b536522e67d0127b42ee9e9e453d4b" title="Copies fields from one message to another.">Message::message_copyFields</a>. </p>
<p>One field: dstOffset, srcOffset, size. </p>

</div>
</div>
<a class="anchor" id="a5b3afce514e90e141d489ffb33e95c12"></a><!-- doxytag: member="Message.h::message_copyFromMessage" ref="a5b3afce514e90e141d489ffb33e95c12" args="(char *dst, const Message *src, ushort msgOffset, ushort size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_copyFromMessage </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>msgOffset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#aaa4f0b8bed37b3b8739e51c4a33af380" title="Copies data from the message body to an application buffer.">Message::message_copyFromMessage</a> </p>

</div>
</div>
<a class="anchor" id="ab5c656492c5d169ddbf490d8a076138c"></a><!-- doxytag: member="Message.h::message_copyToMessage" ref="ab5c656492c5d169ddbf490d8a076138c" args="(const Message *dst, cchar *src, ushort msgOffset, ushort size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_copyToMessage </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#a0f128c3e0c83721af0220c00554e9c4e">cchar</a> *&nbsp;</td>
          <td class="paramname"> <em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>msgOffset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#afede30937f7778cd02a2686c0535e044" title="Copies data from an application buffer to the message body.">Message::message_copyToMessage</a> </p>

</div>
</div>
<a class="anchor" id="a3fbd71fce59e1ed9337447f4e58db2ed"></a><!-- doxytag: member="Message.h::message_create" ref="a3fbd71fce59e1ed9337447f4e58db2ed" args="(ushort)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="structMessage.html">Message</a>* message_create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#aca5526494c50cb46e9d25739d860098c" title="Creates a Message structure.">Message::message_create</a> </p>

</div>
</div>
<a class="anchor" id="a80b69855414b3327d9527d4b96b802c2"></a><!-- doxytag: member="Message.h::message_destroy" ref="a80b69855414b3327d9527d4b96b802c2" args="(Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a15fe0a2ac6e5819f450862a62284e87e" title="Destroys a Message structure.">Message::message_destroy</a> </p>

</div>
</div>
<a class="anchor" id="a59e76138748e61fbefb799649aa2f000"></a><!-- doxytag: member="Message.h::message_fill" ref="a59e76138748e61fbefb799649aa2f000" args="(const Message *dst, char fill, ushort msgOffset, ushort size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_fill </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char&nbsp;</td>
          <td class="paramname"> <em>fill</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>msgOffset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a7a30b2e32e3a6c5ff74cf8b6d8ffde35" title="Fills message body with a character.">Message::message_fill</a> </p>

</div>
</div>
<a class="anchor" id="aaf379ce56fe66f1c234fb96fa75c64a8"></a><!-- doxytag: member="Message.h::message_flags" ref="aaf379ce56fe66f1c234fb96fa75c64a8" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> message_flags </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ae523552e769bebf6d3e43a1f7fcca1f1" title="Retrieves the message flags.">Message::message_flags</a> </p>

</div>
</div>
<a class="anchor" id="ad2f3f3fcb15603d1c2ec93967da7f47b"></a><!-- doxytag: member="Message.h::message_ipAddr" ref="ad2f3f3fcb15603d1c2ec93967da7f47b" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> message_ipAddr </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a6e475725fcfec6e595c174d2b3aa56a2" title="Retrieves the IP address associated with this Message.">Message::message_ipAddr</a> </p>

</div>
</div>
<a class="anchor" id="a3e36335cd07843fe87db161b6b5ef9a3"></a><!-- doxytag: member="Message.h::message_isValidPrefix" ref="a3e36335cd07843fe87db161b6b5ef9a3" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a6e2560c92901098cb3cd008a79dcdeba">bool</a> message_isValidPrefix </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a8813f1306e704c9c7b59cc25b104f418" title="Checks if the Message prefix is valid.">Message::message_isValidPrefix</a> </p>

</div>
</div>
<a class="anchor" id="a5532aa785069586eb5cb0950bc89e630"></a><!-- doxytag: member="Message.h::message_isValidSuffix" ref="a5532aa785069586eb5cb0950bc89e630" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a6e2560c92901098cb3cd008a79dcdeba">bool</a> message_isValidSuffix </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a8524606b8cb2c28dc55892ef87425f8f" title="Checks if the Message suffix is valid.">Message::message_isValidSuffix</a> </p>

</div>
</div>
<a class="anchor" id="ad79085024874f86561123dba96ae34ae"></a><!-- doxytag: member="Message.h::message_maxBodySize" ref="ad79085024874f86561123dba96ae34ae" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> message_maxBodySize </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ad79085024874f86561123dba96ae34ae" title="Retrieves the value configured for the maximum data area size of a message.">Message::message_maxBodySize</a> </p>

</div>
</div>
<a class="anchor" id="ad8b7b738ecb16a51de905ff169b3ee30"></a><!-- doxytag: member="Message.h::message_orgId" ref="ad8b7b738ecb16a51de905ff169b3ee30" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> message_orgId </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a02ce321c76ba95032a6894b5096893a9" title="Retrieves the source identification of this Message.">Message::message_orgId</a> </p>

</div>
</div>
<a class="anchor" id="a2d444165c65e9e524e8e6a10eb008359"></a><!-- doxytag: member="Message.h::message_orgSeqNo" ref="a2d444165c65e9e524e8e6a10eb008359" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> message_orgSeqNo </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a6b67b118a73c8dbcfbdf806b17812ff5" title="Retrieves the sequence number of the Message that was set by the client.">Message::message_orgSeqNo</a> </p>

</div>
</div>
<a class="anchor" id="aee7425cb32cff0e3aa1703ea591373af"></a><!-- doxytag: member="Message.h::message_prefix" ref="aee7425cb32cff0e3aa1703ea591373af" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API char message_prefix </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a8f0de8a9e37b91bc8f3855950a581cc9" title="Retrieves the Message prefix.">Message::message_prefix</a> </p>

</div>
</div>
<a class="anchor" id="ae8533d9aadc4bd5efb9232b3b76ce788"></a><!-- doxytag: member="Message.h::message_seqNo" ref="ae8533d9aadc4bd5efb9232b3b76ce788" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a> message_seqNo </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a8bd306302e7961fef5e355f991fd2070" title="Retrieves the sequence number of this Message.">Message::message_seqNo</a> </p>

</div>
</div>
<a class="anchor" id="a6d134a41d749728e073d200e31d2a1f3"></a><!-- doxytag: member="Message.h::message_setByte" ref="a6d134a41d749728e073d200e31d2a1f3" args="(const Message *dst, ushort msgOffset, uchar byte)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_setByte </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>msgOffset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#a65f85814a8290f9797005d3b28e7e5fc">uchar</a>&nbsp;</td>
          <td class="paramname"> <em>byte</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a9224f61db5310f744f52ad06649f158c" title="Sets one byte in the message body with a byte from the application.">Message::message_setByte</a> </p>

</div>
</div>
<a class="anchor" id="a8ce1fd41a1c00f93525c53e204946a24"></a><!-- doxytag: member="Message.h::message_setMaxSize" ref="a8ce1fd41a1c00f93525c53e204946a24" args="(uint)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_setMaxSize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#aa2a4a15ffe932da3b34b3d4a989d864d" title="Configures the maximum size of the data area for all Messages .">Message::message_setMaxSize</a> </p>

</div>
</div>
<a class="anchor" id="a1d5961c1e7523eacb415b37ac0202a43"></a><!-- doxytag: member="Message.h::message_setOrgId" ref="a1d5961c1e7523eacb415b37ac0202a43" args="(Message *dst, uint orgId)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_setOrgId </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td>
          <td class="paramname"> <em>orgId</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#aab8fc2edae92cb1126c49962fa6bf5bc" title="Sets the source identification of this Message.">Message::message_setOrgId</a> </p>

</div>
</div>
<a class="anchor" id="a7898cab691c81314107190749f4bbd1a"></a><!-- doxytag: member="Message.h::message_setOrgSeqNo" ref="a7898cab691c81314107190749f4bbd1a" args="(Message *dst, ushort orgSeqNo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_setOrgSeqNo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>orgSeqNo</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a8e43c34b2690c17b30abb2b196a20ca1" title="Sets the local sequence number of this Message.">Message::message_setOrgSeqNo</a> </p>

</div>
</div>
<a class="anchor" id="af5c94ce74d859f8493b87d72eb686454"></a><!-- doxytag: member="Message.h::message_setSeqNo" ref="af5c94ce74d859f8493b87d72eb686454" args="(Message *dst, ushort seqNo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_setSeqNo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>dst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>seqNo</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#aa59d4c4678ad429cdc8b544da777093c" title="Sets the sequence number of this Message within its Connection.">Message::message_setSeqNo</a> </p>

</div>
</div>
<a class="anchor" id="ad22c674360e643cc86c86505f64dd170"></a><!-- doxytag: member="Message.h::message_setSize" ref="ad22c674360e643cc86c86505f64dd170" args="(const Message *, ushort size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API void message_setSize </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="config_8h.html#ab95f123a6c9bcfee6a343170ef8c5f69">ushort</a>&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ad69731535e80de38043fff92e741767f" title="Sets the size of the Message data area.">Message::message_setSize</a> </p>

</div>
</div>
<a class="anchor" id="a52415b8242eb5a34b6249d8f9b0cb0f3"></a><!-- doxytag: member="Message.h::message_size" ref="a52415b8242eb5a34b6249d8f9b0cb0f3" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> message_size </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#a752d83635cc98231e3e5f96b0fecba24" title="Retrieves the size of the data area of this Message.">Message::message_size</a> </p>

</div>
</div>
<a class="anchor" id="ab2c30f86b55850b3e0859fc37b9e6aa1"></a><!-- doxytag: member="Message.h::message_size1" ref="ab2c30f86b55850b3e0859fc37b9e6aa1" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> message_size1 </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ab2c30f86b55850b3e0859fc37b9e6aa1" title="Retrieves the size of the part 1 of a Message being received.">Message::message_size1</a> </p>

</div>
</div>
<a class="anchor" id="a2ce7590ea639b229357b29c187c2a2f4"></a><!-- doxytag: member="Message.h::message_size2" ref="a2ce7590ea639b229357b29c187c2a2f4" args="(const Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API <a class="el" href="config_8h.html#a91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> message_size2 </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ae5c0beb7f40308b7f2e8477dd7f3df68" title="Retrieves the size of the part 2 of a Message being received.">Message::message_size2</a> </p>

</div>
</div>
<a class="anchor" id="abd75d5c27798093d703c092bbaf40ef2"></a><!-- doxytag: member="Message.h::message_start" ref="abd75d5c27798093d703c092bbaf40ef2" args="(Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API char* message_start </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ad82725c7d518ca0e3759d5aa1d517233" title="Retrieves the address of on-the-wire contents of this Message.">Message::message_start</a> </p>

</div>
</div>
<a class="anchor" id="a4bda33d4f9469e060c37f2986dd286f3"></a><!-- doxytag: member="Message.h::message_suffix" ref="a4bda33d4f9469e060c37f2986dd286f3" args="(Message *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TC2API char message_suffix </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>see <a class="el" href="structMessage.html#ab5c8cf6a29744dcbf5358f47235f8939" title="Retrives the message suffix.">Message::message_suffix</a> </p>

</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat May 8 16:16:36 2010 for TcpClient2 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
zvx
Software Developer
Brazil Brazil
I'm a long-time software developer living in Brazil.

I've been developing software for retail and banking automation in C/C++ for many years now. In the old days I even did some COBOL programming, and some assembly for the 8080.

My experience ranges from low level software such as interface code for serial devices for DOS and Windows (bar code scanners, printers, cash dispensers, etc) and goes to writing end user applications for POS terminals and bank ATMs. In between I've done a great deal of TCP/IP programming using the basic Berkeley sockets interface, which is my main interest nowadays.

Comments and Discussions