<p>This module define an abstract interface for generic data streams. Note that no code is present, streams are just abstract interfaces like structures, you should look at the systems as to a set of abstract C++ classes (even if written in C). This system has the advantage to make the access to streams independent from the implementation logic.<br/>
The stream interface can be used as base class for high level object types such as files, sockets, serial ports, pipes etc. </p>
<p><aclass="el"href="struct_base_sequential_stream.html"title="Base stream class.">BaseSequentialStream</a> specific methods. </p>
<p>Definition at line <aclass="el"href="chstreams_8h_source.html#l00051">51</a> of file <aclass="el"href="chstreams_8h_source.html">chstreams.h</a>.</p>
<p><code><aclass="el"href="struct_base_sequential_stream.html"title="Base stream class.">BaseSequentialStream</a></code> specific data. </p>
<dlclass="note"><dt><b>Note:</b></dt><dd>It is empty because <code><aclass="el"href="struct_base_sequential_stream.html"title="Base stream class.">BaseSequentialStream</a></code> is only an interface without implementation. </dd></dl>
<p>Definition at line <aclass="el"href="chstreams_8h_source.html#l00062">62</a> of file <aclass="el"href="chstreams_8h_source.html">chstreams.h</a>.</p>
<p>The function writes data from a buffer to a stream.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"><tt>[in]</tt> </td><tdvalign="top"><em>ip</em> </td><td>pointer to a <code><aclass="el"href="struct_base_sequential_stream.html"title="Base stream class.">BaseSequentialStream</a></code> or derived class </td></tr>
<tr><tdvalign="top"><tt>[in]</tt> </td><tdvalign="top"><em>bp</em> </td><td>pointer to the data buffer </td></tr>
<tr><tdvalign="top"><tt>[in]</tt> </td><tdvalign="top"><em>n</em> </td><td>the maximum amount of data to be transferred </td></tr>
</table>
</dd>
</dl>
<dlclass="return"><dt><b>Returns:</b></dt><dd>The number of bytes transferred. The return value can be less than the specified number of bytes if the stream reaches a physical end of file and cannot be extended. </dd></dl>
<p>Definition at line <aclass="el"href="chstreams_8h_source.html#l00094">94</a> of file <aclass="el"href="chstreams_8h_source.html">chstreams.h</a>.</p>
<p>The function reads data from a stream into a buffer.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<tableborder="0"cellspacing="2"cellpadding="0">
<tr><tdvalign="top"><tt>[in]</tt> </td><tdvalign="top"><em>ip</em> </td><td>pointer to a <code><aclass="el"href="struct_base_sequential_stream.html"title="Base stream class.">BaseSequentialStream</a></code> or derived class </td></tr>
<tr><tdvalign="top"><tt>[out]</tt> </td><tdvalign="top"><em>bp</em> </td><td>pointer to the data buffer </td></tr>
<tr><tdvalign="top"><tt>[in]</tt> </td><tdvalign="top"><em>n</em> </td><td>the maximum amount of data to be transferred </td></tr>
</table>
</dd>
</dl>
<dlclass="return"><dt><b>Returns:</b></dt><dd>The number of bytes transferred. The return value can be less than the specified number of bytes if the stream reaches the end of the available data. </dd></dl>
<p>Definition at line <aclass="el"href="chstreams_8h_source.html#l00107">107</a> of file <aclass="el"href="chstreams_8h_source.html">chstreams.h</a>.</p>
Generated on Sun Nov 28 2010 14:09:56 for ChibiOS/RT by <ahref="http://www.doxygen.org/index.html"><imgsrc="doxygen.png"alt="doxygen"align="middle"border="0"></a> 1.7.1</small></address>