| <!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::GenericReader 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_1GenericReader.html">GenericReader</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classavro_1_1GenericReader-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::GenericReader Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A utility class to read generic datum from decoders. |
| <a href="classavro_1_1GenericReader.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="Generic_8hh_source.html">Generic.hh</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for avro::GenericReader:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classavro_1_1GenericReader.png" usemap="#avro::GenericReader_map" alt=""/> |
| <map id="avro::GenericReader_map" name="avro::GenericReader_map"> |
| </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:a78171ec850390e4aebf24ac3d774817b"><td class="memItemLeft" align="right" valign="top"><a id="a78171ec850390e4aebf24ac3d774817b"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericReader.html#a78171ec850390e4aebf24ac3d774817b">GenericReader</a> (const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &s, const <a class="el" href="namespaceavro.html#a7403d421c11fed3d8aa50f412f80b7b5">DecoderPtr</a> &decoder)</td></tr> |
| <tr class="memdesc:a78171ec850390e4aebf24ac3d774817b"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a reader for the given schema using the given decoder. <br /></td></tr> |
| <tr class="separator:a78171ec850390e4aebf24ac3d774817b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac84a8322543af3bfab5739aff040adbb"><td class="memItemLeft" align="right" valign="top"><a id="ac84a8322543af3bfab5739aff040adbb"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericReader.html#ac84a8322543af3bfab5739aff040adbb">GenericReader</a> (const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &writerSchema, const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &readerSchema, const <a class="el" href="namespaceavro.html#a7403d421c11fed3d8aa50f412f80b7b5">DecoderPtr</a> &decoder)</td></tr> |
| <tr class="memdesc:ac84a8322543af3bfab5739aff040adbb"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a reader for the given reader's schema <code>readerSchema</code> using the given decoder which holds data matching writer's schema <code>writerSchema</code>. <br /></td></tr> |
| <tr class="separator:ac84a8322543af3bfab5739aff040adbb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3a46b79b2119f1ac3e4e3b217c612cf"><td class="memItemLeft" align="right" valign="top"><a id="ae3a46b79b2119f1ac3e4e3b217c612cf"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericReader.html#ae3a46b79b2119f1ac3e4e3b217c612cf">read</a> (<a class="el" href="classavro_1_1GenericDatum.html">GenericDatum</a> &datum) const</td></tr> |
| <tr class="memdesc:ae3a46b79b2119f1ac3e4e3b217c612cf"><td class="mdescLeft"> </td><td class="mdescRight">Reads a value off the decoder. <br /></td></tr> |
| <tr class="separator:ae3a46b79b2119f1ac3e4e3b217c612cf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac7ec76bc1e4e7136e8ab6b8ee73c5d07"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericReader.html#ac7ec76bc1e4e7136e8ab6b8ee73c5d07">drain</a> ()</td></tr> |
| <tr class="memdesc:ac7ec76bc1e4e7136e8ab6b8ee73c5d07"><td class="mdescLeft"> </td><td class="mdescRight">Drains any residual bytes in the input stream (e.g. <a href="#ac7ec76bc1e4e7136e8ab6b8ee73c5d07">More...</a><br /></td></tr> |
| <tr class="separator:ac7ec76bc1e4e7136e8ab6b8ee73c5d07"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:abd947cb446ad1c3e102dc718670450ab"><td class="memItemLeft" align="right" valign="top"><a id="abd947cb446ad1c3e102dc718670450ab"></a> |
| static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericReader.html#abd947cb446ad1c3e102dc718670450ab">read</a> (<a class="el" href="classavro_1_1Decoder.html">Decoder</a> &d, <a class="el" href="classavro_1_1GenericDatum.html">GenericDatum</a> &g)</td></tr> |
| <tr class="memdesc:abd947cb446ad1c3e102dc718670450ab"><td class="mdescLeft"> </td><td class="mdescRight">Reads a generic datum from the stream, using the given schema. <br /></td></tr> |
| <tr class="separator:abd947cb446ad1c3e102dc718670450ab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad7d5d16596914c2da5ee6b1ddcd4173c"><td class="memItemLeft" align="right" valign="top"><a id="ad7d5d16596914c2da5ee6b1ddcd4173c"></a> |
| static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1GenericReader.html#ad7d5d16596914c2da5ee6b1ddcd4173c">read</a> (<a class="el" href="classavro_1_1Decoder.html">Decoder</a> &d, <a class="el" href="classavro_1_1GenericDatum.html">GenericDatum</a> &g, const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &s)</td></tr> |
| <tr class="memdesc:ad7d5d16596914c2da5ee6b1ddcd4173c"><td class="mdescLeft"> </td><td class="mdescRight">Reads a generic datum from the stream, using the given schema. <br /></td></tr> |
| <tr class="separator:ad7d5d16596914c2da5ee6b1ddcd4173c"><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 utility class to read generic datum from decoders. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ac7ec76bc1e4e7136e8ab6b8ee73c5d07"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac7ec76bc1e4e7136e8ab6b8ee73c5d07">◆ </a></span>drain()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::GenericReader::drain </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"> |
| |
| <p>Drains any residual bytes in the input stream (e.g. </p> |
| <p>because reader's schema has no use of them) and return unused bytes back to the underlying input stream. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>api/<a class="el" href="Generic_8hh_source.html">Generic.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> |
