andry/lighthub
1
0
Fork 0
mirror of https://github.com/anklimov/lighthub synced 2025-12-06 11:49:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

doxigen docs

Browse Source
This commit is contained in:
Andrey Klimov
2022-01-06 02:01:16 +03:00
parent 6fe28695f2
commit 07046680e0
628 changed files with 37077 additions and 10502 deletions
Download Patch File Download Diff File Expand all files Collapse all files

143
docs/html/seekablestream_8h_source.html Normal file
View File

@@ -0,0 +1,143 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LightHub: seekablestream.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lh.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">LightHub
&#160;<span id="projectnumber">v4.0.0</span>
</div>
<div id="projectbrief">Smarthome controller firmware</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('seekablestream_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">seekablestream.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="seekablestream_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef _SEEKABLESTREAM_H_</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define _SEEKABLESTREAM_H_</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;Stream.h&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;Arduino.h&gt;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="seekablestream_8h.html#ae85f1ca5e05bdfd19aaa06b6f5feaa78"> 7</a></span>&#160;<span class="preprocessor">#define EOFchar 255</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="classseekable_stream.html"> 9</a></span>&#160;<span class="keyword">class </span><a class="code" href="classseekable_stream.html">seekableStream</a> : <span class="keyword">public</span> Stream </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;{</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">protected</span>: </div>
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2"> 12</a></span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2">streamSize</a>; </div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a5fdc0bb9d037754e9ce710cf21f6c7e0"> 13</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classseekable_stream.html#a5fdc0bb9d037754e9ce710cf21f6c7e0">textMode</a>;</div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a4bb972919c0661a11d07e6c854da5ac0"> 14</a></span>&#160;uint16_t <a class="code" href="classseekable_stream.html#a4bb972919c0661a11d07e6c854da5ac0">contentType</a>;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a9a970bf7b1b0c9fe90274baaddbb6f00"> 17</a></span>&#160;<a class="code" href="classseekable_stream.html#a9a970bf7b1b0c9fe90274baaddbb6f00">seekableStream</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size):Stream(),<a class="code" href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2">streamSize</a>(size) {};</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a3506febba145718c7497f6c33cde377d"> 18</a></span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classseekable_stream.html#a3506febba145718c7497f6c33cde377d">checkPermissions</a>(<span class="keywordtype">char</span> mode) {<span class="keywordflow">return</span> <span class="keyword">true</span>;};</div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a49b5cc28add07df1634d815737aaf54d"> 19</a></span>&#160;<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classseekable_stream.html#a49b5cc28add07df1634d815737aaf54d">getSize</a>() {<span class="keywordflow">return</span> <a class="code" href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2">streamSize</a>;}</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a902f161daee83bec42bdb342b315d8a4"> 20</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="classseekable_stream.html#a902f161daee83bec42bdb342b315d8a4">setSize</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {<a class="code" href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2">streamSize</a> = size;};</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a05b0e71f635a107188b57c29b445f3ea"> 21</a></span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classseekable_stream.html#a05b0e71f635a107188b57c29b445f3ea">seek</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _pos = 0) = 0;</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classseekable_stream.html#af28ec1377c94e4c8fa819163c699b402"> 22</a></span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classseekable_stream.html#af28ec1377c94e4c8fa819163c699b402">open</a>(String _filename, <span class="keywordtype">char</span> mode) = 0; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a9a32b4330663e6e2407313d0dd0e255f"> 23</a></span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classseekable_stream.html#a9a32b4330663e6e2407313d0dd0e255f">close</a>() = 0;</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a1d58ac96f37ab0f76300118f3c8e8c9a"> 24</a></span>&#160;<span class="keyword">virtual</span> uint16_t <a class="code" href="classseekable_stream.html#a1d58ac96f37ab0f76300118f3c8e8c9a">getContentType</a>() {<span class="keywordflow">return</span> <a class="code" href="classseekable_stream.html#a4bb972919c0661a11d07e6c854da5ac0">contentType</a>;};</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classseekable_stream.html#a4520969c63f2be885fbc31a396d6f460"> 25</a></span>&#160;<span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classseekable_stream.html#a4520969c63f2be885fbc31a396d6f460">putEOF</a>() {<span class="keywordflow">if</span> (<a class="code" href="classseekable_stream.html#a5fdc0bb9d037754e9ce710cf21f6c7e0">textMode</a>) write (<a class="code" href="seekablestream_8h.html#ae85f1ca5e05bdfd19aaa06b6f5feaa78">EOFchar</a>);};</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;};</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aclassseekable_stream_html_a05b0e71f635a107188b57c29b445f3ea"><div class="ttname"><a href="classseekable_stream.html#a05b0e71f635a107188b57c29b445f3ea">seekableStream::seek</a></div><div class="ttdeci">virtual unsigned int seek(unsigned int _pos=0)=0</div></div>
<div class="ttc" id="aclassseekable_stream_html_a3506febba145718c7497f6c33cde377d"><div class="ttname"><a href="classseekable_stream.html#a3506febba145718c7497f6c33cde377d">seekableStream::checkPermissions</a></div><div class="ttdeci">virtual bool checkPermissions(char mode)</div><div class="ttdef"><b>Definition:</b> seekablestream.h:18</div></div>
<div class="ttc" id="aclassseekable_stream_html_a9a970bf7b1b0c9fe90274baaddbb6f00"><div class="ttname"><a href="classseekable_stream.html#a9a970bf7b1b0c9fe90274baaddbb6f00">seekableStream::seekableStream</a></div><div class="ttdeci">seekableStream(unsigned int size)</div><div class="ttdef"><b>Definition:</b> seekablestream.h:17</div></div>
<div class="ttc" id="aclassseekable_stream_html_a902f161daee83bec42bdb342b315d8a4"><div class="ttname"><a href="classseekable_stream.html#a902f161daee83bec42bdb342b315d8a4">seekableStream::setSize</a></div><div class="ttdeci">void setSize(unsigned int size)</div><div class="ttdef"><b>Definition:</b> seekablestream.h:20</div></div>
<div class="ttc" id="aclassseekable_stream_html_af28ec1377c94e4c8fa819163c699b402"><div class="ttname"><a href="classseekable_stream.html#af28ec1377c94e4c8fa819163c699b402">seekableStream::open</a></div><div class="ttdeci">virtual int open(String _filename, char mode)=0</div></div>
<div class="ttc" id="aclassseekable_stream_html_a1d58ac96f37ab0f76300118f3c8e8c9a"><div class="ttname"><a href="classseekable_stream.html#a1d58ac96f37ab0f76300118f3c8e8c9a">seekableStream::getContentType</a></div><div class="ttdeci">virtual uint16_t getContentType()</div><div class="ttdef"><b>Definition:</b> seekablestream.h:24</div></div>
<div class="ttc" id="aclassseekable_stream_html_a4bb972919c0661a11d07e6c854da5ac0"><div class="ttname"><a href="classseekable_stream.html#a4bb972919c0661a11d07e6c854da5ac0">seekableStream::contentType</a></div><div class="ttdeci">uint16_t contentType</div><div class="ttdef"><b>Definition:</b> seekablestream.h:14</div></div>
<div class="ttc" id="aclassseekable_stream_html"><div class="ttname"><a href="classseekable_stream.html">seekableStream</a></div><div class="ttdef"><b>Definition:</b> seekablestream.h:10</div></div>
<div class="ttc" id="aclassseekable_stream_html_a4e939db97f858ce94111f4a5001a15c2"><div class="ttname"><a href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2">seekableStream::streamSize</a></div><div class="ttdeci">unsigned int streamSize</div><div class="ttdef"><b>Definition:</b> seekablestream.h:12</div></div>
<div class="ttc" id="aclassseekable_stream_html_a4520969c63f2be885fbc31a396d6f460"><div class="ttname"><a href="classseekable_stream.html#a4520969c63f2be885fbc31a396d6f460">seekableStream::putEOF</a></div><div class="ttdeci">virtual void putEOF()</div><div class="ttdef"><b>Definition:</b> seekablestream.h:25</div></div>
<div class="ttc" id="aclassseekable_stream_html_a5fdc0bb9d037754e9ce710cf21f6c7e0"><div class="ttname"><a href="classseekable_stream.html#a5fdc0bb9d037754e9ce710cf21f6c7e0">seekableStream::textMode</a></div><div class="ttdeci">bool textMode</div><div class="ttdef"><b>Definition:</b> seekablestream.h:13</div></div>
<div class="ttc" id="aseekablestream_8h_html_ae85f1ca5e05bdfd19aaa06b6f5feaa78"><div class="ttname"><a href="seekablestream_8h.html#ae85f1ca5e05bdfd19aaa06b6f5feaa78">EOFchar</a></div><div class="ttdeci">#define EOFchar</div><div class="ttdef"><b>Definition:</b> seekablestream.h:7</div></div>
<div class="ttc" id="aclassseekable_stream_html_a49b5cc28add07df1634d815737aaf54d"><div class="ttname"><a href="classseekable_stream.html#a49b5cc28add07df1634d815737aaf54d">seekableStream::getSize</a></div><div class="ttdeci">unsigned int getSize()</div><div class="ttdef"><b>Definition:</b> seekablestream.h:19</div></div>
<div class="ttc" id="aclassseekable_stream_html_a9a32b4330663e6e2407313d0dd0e255f"><div class="ttname"><a href="classseekable_stream.html#a9a32b4330663e6e2407313d0dd0e255f">seekableStream::close</a></div><div class="ttdeci">virtual void close()=0</div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="seekablestream_8h.html">seekablestream.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>