mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
156 lines
8.4 KiB
HTML
156 lines
8.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: Memory Streams</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Defines</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>Memory Streams<br/>
|
|
<small>
|
|
[<a class="el" href="group__various.html">Various</a>]</small>
|
|
</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
|
|
<p>Memory Streams.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><div class="dynheader">
|
|
Collaboration diagram for Memory Streams:</div>
|
|
<div class="dyncontent">
|
|
<center><table><tr><td><img src="group__memory__streams.png" border="0" alt="" usemap="#group____memory____streams"/>
|
|
<map name="group____memory____streams" id="group____memory____streams">
|
|
<area shape="rect" id="node2" href="group__various.html" title="Utilities Library." alt="" coords="7,5,65,32"/>
|
|
</map>
|
|
</td></tr></table></center>
|
|
</div>
|
|
</p>
|
|
<hr/><a name="_details"></a><h2>Description</h2>
|
|
<p>Memory Streams. </p>
|
|
<p>This module allows to use a memory area (RAM or ROM) using a <a class="el" href="group__data__streams.html">Data Streams</a> interface. </p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_mem_stream_v_m_t.html">MemStreamVMT</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight"><code>MemStream</code> virtual methods table. <a href="struct_mem_stream_v_m_t.html#_details">More...</a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_memory_stream.html">MemoryStream</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory stream object. <a href="struct_memory_stream.html#_details">More...</a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="define-members"></a>
|
|
Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__memory__streams.html#gae6713e95d4a8f2ce6aa91063cbd499c9">_memory_stream_data</a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight"><code>RamStream</code> specific data. <a href="#gae6713e95d4a8f2ce6aa91063cbd499c9"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__memory__streams.html#gac6c4df5591b95b17517fa9a53c3cf120">msObjectInit</a> (<a class="el" href="struct_memory_stream.html">MemoryStream</a> *msp, <a class="el" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buffer, size_t size, size_t eos)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Memory stream object initialization. <a href="#gac6c4df5591b95b17517fa9a53c3cf120"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><h2>Define Documentation</h2>
|
|
<a class="anchor" id="gae6713e95d4a8f2ce6aa91063cbd499c9"></a><!-- doxytag: member="memstreams.h::_memory_stream_data" ref="gae6713e95d4a8f2ce6aa91063cbd499c9" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define _memory_stream_data</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="group__data__streams.html#gabac5bf050a931f5a3be6cac09ba7b373" title="BaseSequentialStream specific data.">_base_sequential_stream_data</a> \
|
|
<span class="comment">/* Pointer to the stream buffer.*/</span> \
|
|
<a class="code" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *buffer; \
|
|
<span class="comment">/* Size of the stream.*/</span> \
|
|
<span class="keywordtype">size_t</span> size; \
|
|
<span class="comment">/* Current end of stream.*/</span> \
|
|
<span class="keywordtype">size_t</span> eos; \
|
|
<span class="comment">/* Current read offset.*/</span> \
|
|
<span class="keywordtype">size_t</span> offset;
|
|
</pre></div>
|
|
<p><code>RamStream</code> specific data. </p>
|
|
|
|
<p>Definition at line <a class="el" href="memstreams_8h_source.html#l00041">41</a> of file <a class="el" href="memstreams_8h_source.html">memstreams.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="gac6c4df5591b95b17517fa9a53c3cf120"></a><!-- doxytag: member="memstreams.c::msObjectInit" ref="gac6c4df5591b95b17517fa9a53c3cf120" args="(MemoryStream *msp, uint8_t *buffer, size_t size, size_t eos)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void msObjectInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="struct_memory_stream.html">MemoryStream</a> * </td>
|
|
<td class="paramname"> <em>msp</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group___s_t_m8___c_o_r_e.html#gaba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </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>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"> <em>eos</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Memory stream object initialization. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>msp</em> </td><td>pointer to the <code><a class="el" href="struct_memory_stream.html" title="Memory stream object.">MemoryStream</a></code> object to be initialized </td></tr>
|
|
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>buffer</em> </td><td>pointer to the memory buffer for the memory stream </td></tr>
|
|
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>total size of the memory stream buffer </td></tr>
|
|
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>eos</em> </td><td>initial End Of Stream offset. Normally you need to put this to zero for RAM buffers or equal to <code>size</code> for ROM streams. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Nov 28 2010 14:09:59 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|