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
Files
30f7b36a9cdf4a59d9ed79c78e9bef497c902039
lighthub/docs/html/classseekable_stream.html
Andrey Klimov 07046680e0 doxigen docs
2022-01-06 02:01:16 +03:00

466 lines
19 KiB
HTML
Raw Blame History

<!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 Class Reference</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('classseekable_stream.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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classseekable_stream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">seekableStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="seekablestream_8h_source.html">seekablestream.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for seekableStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classseekable_stream.png" usemap="#seekableStream_map" alt=""/>
<map id="seekableStream_map" name="seekableStream_map">
<area href="classflash_stream.html" alt="flashStream" shape="rect" coords="0,112,101,136"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9a970bf7b1b0c9fe90274baaddbb6f00"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a9a970bf7b1b0c9fe90274baaddbb6f00">seekableStream</a> (unsigned int size)</td></tr>
<tr class="separator:a9a970bf7b1b0c9fe90274baaddbb6f00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3506febba145718c7497f6c33cde377d"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a3506febba145718c7497f6c33cde377d">checkPermissions</a> (char mode)</td></tr>
<tr class="separator:a3506febba145718c7497f6c33cde377d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49b5cc28add07df1634d815737aaf54d"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a49b5cc28add07df1634d815737aaf54d">getSize</a> ()</td></tr>
<tr class="separator:a49b5cc28add07df1634d815737aaf54d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a902f161daee83bec42bdb342b315d8a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a902f161daee83bec42bdb342b315d8a4">setSize</a> (unsigned int size)</td></tr>
<tr class="separator:a902f161daee83bec42bdb342b315d8a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05b0e71f635a107188b57c29b445f3ea"><td class="memItemLeft" align="right" valign="top">virtual unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a05b0e71f635a107188b57c29b445f3ea">seek</a> (unsigned int _pos=0)=0</td></tr>
<tr class="separator:a05b0e71f635a107188b57c29b445f3ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af28ec1377c94e4c8fa819163c699b402"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#af28ec1377c94e4c8fa819163c699b402">open</a> (String _filename, char mode)=0</td></tr>
<tr class="separator:af28ec1377c94e4c8fa819163c699b402"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a32b4330663e6e2407313d0dd0e255f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a9a32b4330663e6e2407313d0dd0e255f">close</a> ()=0</td></tr>
<tr class="separator:a9a32b4330663e6e2407313d0dd0e255f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d58ac96f37ab0f76300118f3c8e8c9a"><td class="memItemLeft" align="right" valign="top">virtual uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a1d58ac96f37ab0f76300118f3c8e8c9a">getContentType</a> ()</td></tr>
<tr class="separator:a1d58ac96f37ab0f76300118f3c8e8c9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4520969c63f2be885fbc31a396d6f460"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a4520969c63f2be885fbc31a396d6f460">putEOF</a> ()</td></tr>
<tr class="separator:a4520969c63f2be885fbc31a396d6f460"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4e939db97f858ce94111f4a5001a15c2"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a4e939db97f858ce94111f4a5001a15c2">streamSize</a></td></tr>
<tr class="separator:a4e939db97f858ce94111f4a5001a15c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fdc0bb9d037754e9ce710cf21f6c7e0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a5fdc0bb9d037754e9ce710cf21f6c7e0">textMode</a></td></tr>
<tr class="separator:a5fdc0bb9d037754e9ce710cf21f6c7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb972919c0661a11d07e6c854da5ac0"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classseekable_stream.html#a4bb972919c0661a11d07e6c854da5ac0">contentType</a></td></tr>
<tr class="separator:a4bb972919c0661a11d07e6c854da5ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9a970bf7b1b0c9fe90274baaddbb6f00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a970bf7b1b0c9fe90274baaddbb6f00">&#9670;&nbsp;</a></span>seekableStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">seekableStream::seekableStream </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3506febba145718c7497f6c33cde377d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3506febba145718c7497f6c33cde377d">&#9670;&nbsp;</a></span>checkPermissions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool seekableStream::checkPermissions </td>
<td>(</td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9a32b4330663e6e2407313d0dd0e255f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a32b4330663e6e2407313d0dd0e255f">&#9670;&nbsp;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void seekableStream::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classflash_stream.html#a81da3f19ab4811aa93ce52ddd3bd188a">flashStream</a>.</p>
</div>
</div>
<a id="a1d58ac96f37ab0f76300118f3c8e8c9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d58ac96f37ab0f76300118f3c8e8c9a">&#9670;&nbsp;</a></span>getContentType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint16_t seekableStream::getContentType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a49b5cc28add07df1634d815737aaf54d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49b5cc28add07df1634d815737aaf54d">&#9670;&nbsp;</a></span>getSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int seekableStream::getSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="af28ec1377c94e4c8fa819163c699b402"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af28ec1377c94e4c8fa819163c699b402">&#9670;&nbsp;</a></span>open()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int seekableStream::open </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>_filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classflash_stream.html#aed80292a0950c246404f4a62d2fb40c7">flashStream</a>.</p>
</div>
</div>
<a id="a4520969c63f2be885fbc31a396d6f460"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4520969c63f2be885fbc31a396d6f460">&#9670;&nbsp;</a></span>putEOF()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void seekableStream::putEOF </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a05b0e71f635a107188b57c29b445f3ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05b0e71f635a107188b57c29b445f3ea">&#9670;&nbsp;</a></span>seek()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int seekableStream::seek </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>_pos</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classflash_stream.html#a7a48d386946f8c123006dc060173f376">flashStream</a>.</p>
</div>
</div>
<a id="a902f161daee83bec42bdb342b315d8a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a902f161daee83bec42bdb342b315d8a4">&#9670;&nbsp;</a></span>setSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void seekableStream::setSize </td>
<td>(</td>
<td class="paramtype">unsigned int&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4bb972919c0661a11d07e6c854da5ac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb972919c0661a11d07e6c854da5ac0">&#9670;&nbsp;</a></span>contentType</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t seekableStream::contentType</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4e939db97f858ce94111f4a5001a15c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e939db97f858ce94111f4a5001a15c2">&#9670;&nbsp;</a></span>streamSize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned int seekableStream::streamSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a5fdc0bb9d037754e9ce710cf21f6c7e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fdc0bb9d037754e9ce710cf21f6c7e0">&#9670;&nbsp;</a></span>textMode</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool seekableStream::textMode</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="seekablestream_8h_source.html">seekablestream.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classseekable_stream.html">seekableStream</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>
Reference in New Issue View Git Blame Copy Permalink