| <!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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Avro C++: avro::InputStream 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="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="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Avro C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> |
| <!-- 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 id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceavro.html">avro</a></li><li class="navelem"><a class="el" href="classavro_1_1InputStream.html">InputStream</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="classavro_1_1InputStream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::InputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A no-copy input stream. |
| <a href="classavro_1_1InputStream.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="Stream_8hh_source.html">Stream.hh</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for avro::InputStream:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classavro_1_1InputStream.png" usemap="#avro::InputStream_map" alt=""/> |
| <map id="avro::InputStream_map" name="avro::InputStream_map"> |
| <area href="classavro_1_1SeekableInputStream.html" title="An InputStream which also supports seeking to a specific offset." alt="avro::SeekableInputStream" shape="rect" coords="0,112,162,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:a4f2baadd95e3b7668458ecb22ce7ce8c"><td class="memItemLeft" align="right" valign="top"><a id="a4f2baadd95e3b7668458ecb22ce7ce8c"></a> |
| virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a4f2baadd95e3b7668458ecb22ce7ce8c">~InputStream</a> ()=default</td></tr> |
| <tr class="memdesc:a4f2baadd95e3b7668458ecb22ce7ce8c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr> |
| <tr class="separator:a4f2baadd95e3b7668458ecb22ce7ce8c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a87767c15b0661981d24f7a42bfcef6b5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a87767c15b0661981d24f7a42bfcef6b5">next</a> (const uint8_t **data, size_t *len)=0</td></tr> |
| <tr class="memdesc:a87767c15b0661981d24f7a42bfcef6b5"><td class="mdescLeft"> </td><td class="mdescRight">Returns some of available data. <a href="classavro_1_1InputStream.html#a87767c15b0661981d24f7a42bfcef6b5">More...</a><br /></td></tr> |
| <tr class="separator:a87767c15b0661981d24f7a42bfcef6b5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a03f9cfac5f7a0141bfe7d6cc4bc7a0d0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a03f9cfac5f7a0141bfe7d6cc4bc7a0d0">backup</a> (size_t len)=0</td></tr> |
| <tr class="memdesc:a03f9cfac5f7a0141bfe7d6cc4bc7a0d0"><td class="mdescLeft"> </td><td class="mdescRight">"Returns" back some of the data to the stream. <a href="classavro_1_1InputStream.html#a03f9cfac5f7a0141bfe7d6cc4bc7a0d0">More...</a><br /></td></tr> |
| <tr class="separator:a03f9cfac5f7a0141bfe7d6cc4bc7a0d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ec852f779fc68dea8fef197ec3eef1d"><td class="memItemLeft" align="right" valign="top"><a id="a4ec852f779fc68dea8fef197ec3eef1d"></a> |
| virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a4ec852f779fc68dea8fef197ec3eef1d">skip</a> (size_t len)=0</td></tr> |
| <tr class="memdesc:a4ec852f779fc68dea8fef197ec3eef1d"><td class="mdescLeft"> </td><td class="mdescRight">Skips number of bytes specified by len. <br /></td></tr> |
| <tr class="separator:a4ec852f779fc68dea8fef197ec3eef1d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acfacc38121fd95e0644b480618b610f3"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#acfacc38121fd95e0644b480618b610f3">byteCount</a> () const =0</td></tr> |
| <tr class="memdesc:acfacc38121fd95e0644b480618b610f3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of bytes read from this stream so far. <a href="classavro_1_1InputStream.html#acfacc38121fd95e0644b480618b610f3">More...</a><br /></td></tr> |
| <tr class="separator:acfacc38121fd95e0644b480618b610f3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a20dd1a09659c9a3608d81db745738bca"><td class="memItemLeft" align="right" valign="top"><a id="a20dd1a09659c9a3608d81db745738bca"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a20dd1a09659c9a3608d81db745738bca">InputStream</a> ()=default</td></tr> |
| <tr class="memdesc:a20dd1a09659c9a3608d81db745738bca"><td class="mdescLeft"> </td><td class="mdescRight">An empty constructor. <br /></td></tr> |
| <tr class="separator:a20dd1a09659c9a3608d81db745738bca"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A no-copy input stream. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a03f9cfac5f7a0141bfe7d6cc4bc7a0d0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a03f9cfac5f7a0141bfe7d6cc4bc7a0d0">◆ </a></span>backup()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual void avro::InputStream::backup </td> |
| <td>(</td> |
| <td class="paramtype">size_t </td> |
| <td class="paramname"><em>len</em></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>"Returns" back some of the data to the stream. </p> |
| <p>The returned data must be less than what was obtained in the last call to <a class="el" href="classavro_1_1InputStream.html#a87767c15b0661981d24f7a42bfcef6b5" title="Returns some of available data.">next()</a>. </p> |
| |
| <p class="reference">Referenced by <a class="el" href="structavro_1_1StreamReader.html#a8c31fc602f068368d7a0e91eea71c4de">avro::StreamReader::drain()</a>, and <a class="el" href="structavro_1_1StreamReader.html#a293c20163efcc2d0380fab80f3c82058">avro::StreamReader::reset()</a>.</p> |
| |
| </div> |
| </div> |
| <a id="acfacc38121fd95e0644b480618b610f3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#acfacc38121fd95e0644b480618b610f3">◆ </a></span>byteCount()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual size_t avro::InputStream::byteCount </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</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>Returns the number of bytes read from this stream so far. </p> |
| <p>All the bytes made available through next are considered to be used unless, returned back using backup. </p> |
| |
| </div> |
| </div> |
| <a id="a87767c15b0661981d24f7a42bfcef6b5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a87767c15b0661981d24f7a42bfcef6b5">◆ </a></span>next()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool avro::InputStream::next </td> |
| <td>(</td> |
| <td class="paramtype">const uint8_t ** </td> |
| <td class="paramname"><em>data</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">size_t * </td> |
| <td class="paramname"><em>len</em> </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>Returns some of available data. </p> |
| <p>Returns true if some data is available, false if no more data is available or an error has occurred. </p> |
| |
| <p class="reference">Referenced by <a class="el" href="namespaceavro.html#adeab3d9f5f2a4a4f96d3ffb8ba27e523">avro::copy()</a>, and <a class="el" href="structavro_1_1StreamReader.html#af255c4f8690be489a0b623328e1cee76">avro::StreamReader::fill()</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>api/<a class="el" href="Stream_8hh_source.html">Stream.hh</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
