<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: UARTBuffer Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1UARTBuffer.html">UARTBuffer</a>
</div>
</div>
<div class="contents">
<h1>UARTBuffer Class Reference</h1><!-- doxytag: class="TelEngine::UARTBuffer" -->A fixed length byte accumulator used by an <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatemodem_8h-source.html">yatemodem.h</a>></code>
<p>
<p>
<a href="classTelEngine_1_1UARTBuffer-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UARTBuffer.html#a088061fe2beee4c0311bf838cf6176e">UARTBuffer</a> (<a class="el" href="classTelEngine_1_1UART.html">UART</a> *client)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UARTBuffer.html#ef4b4ca09dc9fa6950b8a7293f5e0383">buffer</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UARTBuffer.html#5db13496564758e8576dfa3d057b9023">free</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UARTBuffer.html#ef603afa6525c4959916d86d22e05639">reset</a> (unsigned int len=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1UARTBuffer.html#bd22dc3e293742fc5306f4cf66616212">accumulate</a> (unsigned char value)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A fixed length byte accumulator used by an <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a>.
<p>
This class is used by an <a class="el" href="classTelEngine_1_1UART.html" title="An UART receiver/transmitter.">UART</a> to accumulate messages with known length <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a088061fe2beee4c0311bf838cf6176e"></a><!-- doxytag: member="TelEngine::UARTBuffer::UARTBuffer" ref="a088061fe2beee4c0311bf838cf6176e" args="(UART *client)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1UARTBuffer.html">UARTBuffer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classTelEngine_1_1UART.html">UART</a> * </td>
<td class="paramname"> <em>client</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>client</em> </td><td>The client of this buffer </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bd22dc3e293742fc5306f4cf66616212"></a><!-- doxytag: member="TelEngine::UARTBuffer::accumulate" ref="bd22dc3e293742fc5306f4cf66616212" args="(unsigned char value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool accumulate </td>
<td>(</td>
<td class="paramtype">unsigned char </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Accumulate data <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value to append to the buffer </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False on buffer overflow </dd></dl>
<p>References <a class="el" href="namespaceTelEngine.html#3340bc2f81fe3a2eb7b8ed6778d84a37">TelEngine::Debug()</a>.</p>
</div>
</div><p>
<a class="anchor" name="ef4b4ca09dc9fa6950b8a7293f5e0383"></a><!-- doxytag: member="TelEngine::UARTBuffer::buffer" ref="ef4b4ca09dc9fa6950b8a7293f5e0383" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a>& buffer </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the accumulated data <dl class="return" compact><dt><b>Returns:</b></dt><dd>The accumulated data </dd></dl>
</div>
</div><p>
<a class="anchor" name="5db13496564758e8576dfa3d057b9023"></a><!-- doxytag: member="TelEngine::UARTBuffer::free" ref="5db13496564758e8576dfa3d057b9023" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int free </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the free space length in the buffer <dl class="return" compact><dt><b>Returns:</b></dt><dd>The free space length </dd></dl>
</div>
</div><p>
<a class="anchor" name="ef603afa6525c4959916d86d22e05639"></a><!-- doxytag: member="TelEngine::UARTBuffer::reset" ref="ef603afa6525c4959916d86d22e05639" args="(unsigned int len=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void reset </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</em> = <code>0</code> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the buffer <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The new length of the buffer. Set to 0 to left the length unchanged </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatemodem_8h-source.html">yatemodem.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
644
