📄 buffer_8h-source.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>Procyon AVRlib: buffer.h Source File</title><link href="dox.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.6 --><div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>buffer.h</h1><a href="buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*! \file buffer.h \brief Multipurpose byte buffer structure and methods. */</span>00002 <span class="comment">//*****************************************************************************</span>00003 <span class="comment">//</span>00004 <span class="comment">// File Name : 'buffer.h'</span>00005 <span class="comment">// Title : Multipurpose byte buffer structure and methods</span>00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2001-2002</span>00007 <span class="comment">// Created : 9/23/2001</span>00008 <span class="comment">// Revised : 11/16/2002</span>00009 <span class="comment">// Version : 1.1</span>00010 <span class="comment">// Target MCU : any</span>00011 <span class="comment">// Editor Tabs : 4</span>00012 <span class="comment">//</span>00013 <span class="comment">// This code is distributed under the GNU Public License</span>00014 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span>00015 <span class="comment">//</span>00016 <span class="comment">//*****************************************************************************</span>00017 00018 <span class="preprocessor">#ifndef BUFFER_H</span>00019 <span class="preprocessor"></span><span class="preprocessor">#define BUFFER_H</span>00020 <span class="preprocessor"></span>00021 <span class="comment">// structure/typdefs</span>00022 00023 <span class="comment">// the cBuffer structure</span>00024 <span class="keyword">typedef</span> <span class="keyword">struct </span>struct_cBuffer00025 {00026 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *dataptr; <span class="comment">// the physical memory address where the buffer is stored</span>00027 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> size; <span class="comment">// the allocated size of the buffer</span>00028 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> datalength; <span class="comment">// the length of the data currently in the buffer</span>00029 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> dataindex; <span class="comment">// the index into the buffer where the data starts</span>00030 } cBuffer;00031 00032 <span class="comment">// function prototypes</span>00033 <span class="comment"></span>00034 <span class="comment">//! initialize a buffer to start at a given address and have given size</span>00035 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="buffer_8h.html#a1">bufferInit</a>(cBuffer* buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *start, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> size);00036 <span class="comment"></span>00037 <span class="comment">//! get the first byte from the front of the buffer</span>00038 <span class="comment"></span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="buffer_8h.html#a2">bufferGetFromFront</a>(cBuffer* buffer);00039 <span class="comment"></span>00040 <span class="comment">//! dump (discard) the first numbytes from the front of the buffer</span>00041 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="buffer_8h.html#a3">bufferDumpFromFront</a>(cBuffer* buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> numbytes);00042 <span class="comment"></span>00043 <span class="comment">//! get a byte at the specified index in the buffer (kind of like array access)</span>00044 <span class="comment"></span><span class="comment">// ** note: this does not remove the byte that was read from the buffer</span>00045 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="buffer_8h.html#a4">bufferGetAtIndex</a>(cBuffer* buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);00046 <span class="comment"></span>00047 <span class="comment">//! add a byte to the end of the buffer</span>00048 <span class="comment"></span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="buffer_8h.html#a5">bufferAddToEnd</a>(cBuffer* buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> data);00049 <span class="comment"></span>00050 <span class="comment">//! check if the buffer is full/not full (returns non-zero value if not full)</span>00051 <span class="comment"></span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="buffer_8h.html#a6">bufferIsNotFull</a>(cBuffer* buffer);00052 <span class="comment"></span>00053 <span class="comment">//! flush (clear) the contents of the buffer</span>00054 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="buffer_8h.html#a7">bufferFlush</a>(cBuffer* buffer);00055 00056 <span class="preprocessor">#endif</span></pre></div><hr size="1"><address style="align: right;"><small>Generated on Fri Oct 15 03:50:21 2004 for Procyon AVRlib by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 > </a>1.3.6 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -