| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Avro C++: avro::SeekableInputStream 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.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </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_1SeekableInputStream.html">SeekableInputStream</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_1SeekableInputStream-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::SeekableInputStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An <a class="el" href="classavro_1_1InputStream.html" title="A no-copy input stream. ">InputStream</a> which also supports seeking to a specific offset. |
| <a href="classavro_1_1SeekableInputStream.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::SeekableInputStream:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classavro_1_1SeekableInputStream.png" usemap="#avro::SeekableInputStream_map" alt=""/> |
| <map id="avro::SeekableInputStream_map" name="avro::SeekableInputStream_map"> |
| <area href="classavro_1_1InputStream.html" title="A no-copy input stream. " alt="avro::InputStream" shape="rect" coords="0,56,162,80"/> |
| </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:a0f24f251960fc35d9b82401b0d07e5f0"><td class="memItemLeft" align="right" valign="top"><a id="a0f24f251960fc35d9b82401b0d07e5f0"></a> |
| virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1SeekableInputStream.html#a0f24f251960fc35d9b82401b0d07e5f0">~SeekableInputStream</a> ()</td></tr> |
| <tr class="memdesc:a0f24f251960fc35d9b82401b0d07e5f0"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr> |
| <tr class="separator:a0f24f251960fc35d9b82401b0d07e5f0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8cb112cf58c021a6e2ac64216997f0b6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1SeekableInputStream.html#a8cb112cf58c021a6e2ac64216997f0b6">seek</a> (int64_t position)=0</td></tr> |
| <tr class="memdesc:a8cb112cf58c021a6e2ac64216997f0b6"><td class="mdescLeft"> </td><td class="mdescRight">Seek to a specific position in the stream. <a href="#a8cb112cf58c021a6e2ac64216997f0b6">More...</a><br /></td></tr> |
| <tr class="separator:a8cb112cf58c021a6e2ac64216997f0b6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classavro_1_1InputStream"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classavro_1_1InputStream')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classavro_1_1InputStream.html">avro::InputStream</a></td></tr> |
| <tr class="memitem:a1536aeefa0571f9fd80181503b6f501e inherit pub_methods_classavro_1_1InputStream"><td class="memItemLeft" align="right" valign="top"><a id="a1536aeefa0571f9fd80181503b6f501e"></a> |
| virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a1536aeefa0571f9fd80181503b6f501e">~InputStream</a> ()</td></tr> |
| <tr class="memdesc:a1536aeefa0571f9fd80181503b6f501e inherit pub_methods_classavro_1_1InputStream"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr> |
| <tr class="separator:a1536aeefa0571f9fd80181503b6f501e inherit pub_methods_classavro_1_1InputStream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a87767c15b0661981d24f7a42bfcef6b5 inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a03f9cfac5f7a0141bfe7d6cc4bc7a0d0 inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4ec852f779fc68dea8fef197ec3eef1d inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><td class="mdescLeft"> </td><td class="mdescRight">Skips number of bytes specified by len. <br /></td></tr> |
| <tr class="separator:a4ec852f779fc68dea8fef197ec3eef1d inherit pub_methods_classavro_1_1InputStream"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acfacc38121fd95e0644b480618b610f3 inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><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 inherit pub_methods_classavro_1_1InputStream"><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:a52fe8b3d7074457b098dbdcfe6835557"><td class="memItemLeft" align="right" valign="top"><a id="a52fe8b3d7074457b098dbdcfe6835557"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1SeekableInputStream.html#a52fe8b3d7074457b098dbdcfe6835557">SeekableInputStream</a> ()</td></tr> |
| <tr class="memdesc:a52fe8b3d7074457b098dbdcfe6835557"><td class="mdescLeft"> </td><td class="mdescRight">An empty constuctor. <br /></td></tr> |
| <tr class="separator:a52fe8b3d7074457b098dbdcfe6835557"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_classavro_1_1InputStream"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classavro_1_1InputStream')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classavro_1_1InputStream.html">avro::InputStream</a></td></tr> |
| <tr class="memitem:a252c2091ab50e6060e33ccbc7878bc6c inherit pro_methods_classavro_1_1InputStream"><td class="memItemLeft" align="right" valign="top"><a id="a252c2091ab50e6060e33ccbc7878bc6c"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1InputStream.html#a252c2091ab50e6060e33ccbc7878bc6c">InputStream</a> ()</td></tr> |
| <tr class="memdesc:a252c2091ab50e6060e33ccbc7878bc6c inherit pro_methods_classavro_1_1InputStream"><td class="mdescLeft"> </td><td class="mdescRight">An empty constuctor. <br /></td></tr> |
| <tr class="separator:a252c2091ab50e6060e33ccbc7878bc6c inherit pro_methods_classavro_1_1InputStream"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>An <a class="el" href="classavro_1_1InputStream.html" title="A no-copy input stream. ">InputStream</a> which also supports seeking to a specific offset. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a8cb112cf58c021a6e2ac64216997f0b6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8cb112cf58c021a6e2ac64216997f0b6">◆ </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 void avro::SeekableInputStream::seek </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>position</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>Seek to a specific position in the stream. </p> |
| <p>This may invalidate pointers returned from <a class="el" href="classavro_1_1InputStream.html#a87767c15b0661981d24f7a42bfcef6b5" title="Returns some of available data. ">next()</a>. This will also reset <a class="el" href="classavro_1_1InputStream.html#acfacc38121fd95e0644b480618b610f3" title="Returns the number of bytes read from this stream so far. ">byteCount()</a> to the given position. </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.13 |
| </small></address> |
| </body> |
| </html> |
