1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<HTML>
<HEAD>
<TITLE>class UARTBuffer</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>class UARTBuffer</h1>
</TD>
<TD valign="top" align="right" colspan="1">A fixed length byte accumulator used by an UART. <small><A HREF="#longdesc">More...</A></small></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
<TR><TH>Full name</TH><TD><code><A HREF="TelEngine.html">TelEngine</A>::UARTBuffer</code></TD></TR>
<TR><TH>Definition</TH><TD><code>#include <<A HREF="libs___ymodem___yatemodem_h.html">libs/ymodem/yatemodem.h</A>></code></TD></TR>
<TR><TH><A HREF="full-list-TelEngine__UARTBuffer.html">List of all Methods</A></TH></TR>
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h4>Public Methods</h4><ul><LI>inline <b><A HREF="#ref1">UARTBuffer</A></b> (UART* client)
</LI>
<LI>inline const DataBlock& <b><A HREF="#ref2">buffer</A></b> () const
</LI>
<LI>inline unsigned int <b><A HREF="#ref3">free</A></b> () const
</LI>
<LI>inline void <b><A HREF="#ref4">reset</A></b> (unsigned int len = 0)
</LI>
<LI>inline bool <b><A HREF="#ref5">accumulate</A></b> (unsigned char value)
</LI>
</ul><HR><H2><A NAME="longdesc">Detailed Description</A></H2><p>
This class is used by an UART to accumulate messages with known length
</p>
<A NAME="UARTBuffer"></A><A NAME="ref1"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline <strong>UARTBuffer</strong> (UART* client)
<br></td><td align="right"><h3><strong>UARTBuffer</strong></h3></td></tr></table><p></p><p>
Constructor
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>client</i></TD><TD align="left" valign="top">The client of this buffer
</TD></TR>
</TABLE></P>
<A NAME="buffer"></A><A NAME="ref2"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline const DataBlock& <strong>buffer</strong> ()
<br></td><td align="right"><h3><strong>buffer</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the accumulated data
</p>
<p><b>Returns</b>: The accumulated data
</p>
<A NAME="free"></A><A NAME="ref3"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline unsigned int <strong>free</strong> ()
<br></td><td align="right"><h3><strong>free</strong></h3></td></tr></table><p> <small>[const]</small></p><p>
Get the free space length in the buffer
</p>
<p><b>Returns</b>: The free space length
</p>
<A NAME="reset"></A><A NAME="ref4"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline void <strong>reset</strong> (unsigned int len = 0)
<br></td><td align="right"><h3><strong>reset</strong></h3></td></tr></table><p></p><p>
Reset the buffer
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>len</i></TD><TD align="left" valign="top">The new length of the buffer. Set to 0 to left the length unchanged
</TD></TR>
</TABLE></P>
<A NAME="accumulate"></A><A NAME="ref5"></A><table width="100%"><tr bgcolor="#eeeeee"><td>inline bool <strong>accumulate</strong> (unsigned char value)
<br></td><td align="right"><h3><strong>accumulate</strong></h3></td></tr></table><p></p><p>
Accumulate data
</p>
<p><b>Parameters</b>:<TABLE BORDER="0" CELLPADDING="5">
<TR><TD align="left" valign="top"><i>value</i></TD><TD align="left" valign="top">The value to append to the buffer
</TD></TR>
</TABLE></P>
<p><b>Returns</b>: False on buffer overflow
</p>
<HR>
<table>
<tr><td><small>Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.</small></td></tr>
</table>
</BODY>
</HTML>
|
