| <!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::DataFileWriter< T > Class Template 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_1DataFileWriter.html">DataFileWriter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classavro_1_1DataFileWriter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::DataFileWriter< T > Class Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>An Avro datafile that can store objects of type T. |
| <a href="classavro_1_1DataFileWriter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="DataFile_8hh_source.html">DataFile.hh</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for avro::DataFileWriter< T >:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classavro_1_1DataFileWriter.png" usemap="#avro::DataFileWriter_3C_20T_20_3E_map" alt=""/> |
| <map id="avro::DataFileWriter_3C_20T_20_3E_map" name="avro::DataFileWriter_3C_20T_20_3E_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:adf128ce4d3165dedba19b09ea478f756"><td class="memItemLeft" align="right" valign="top"><a id="adf128ce4d3165dedba19b09ea478f756"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriter.html#adf128ce4d3165dedba19b09ea478f756">DataFileWriter</a> (const char *filename, const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &<a class="el" href="classavro_1_1DataFileWriter.html#aafa35ead8509f13cb99905fe6dfae7e0">schema</a>, size_t syncInterval=16 *1024, <a class="el" href="namespaceavro.html#a348c1fae0c6b9d7524b00be30a2746b2">Codec</a> codec=NULL_CODEC)</td></tr> |
| <tr class="memdesc:adf128ce4d3165dedba19b09ea478f756"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new data file. <br /></td></tr> |
| <tr class="separator:adf128ce4d3165dedba19b09ea478f756"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5fcaabd29c423bb06d7e166fd7fc363d"><td class="memItemLeft" align="right" valign="top"><a id="a5fcaabd29c423bb06d7e166fd7fc363d"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>DataFileWriter</b> (std::unique_ptr< <a class="el" href="classavro_1_1OutputStream.html">OutputStream</a> > outputStream, const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &<a class="el" href="classavro_1_1DataFileWriter.html#aafa35ead8509f13cb99905fe6dfae7e0">schema</a>, size_t syncInterval=16 *1024, <a class="el" href="namespaceavro.html#a348c1fae0c6b9d7524b00be30a2746b2">Codec</a> codec=NULL_CODEC)</td></tr> |
| <tr class="separator:a5fcaabd29c423bb06d7e166fd7fc363d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae9dbcfac61016564f39ee9b13e36311c"><td class="memItemLeft" align="right" valign="top"><a id="ae9dbcfac61016564f39ee9b13e36311c"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriter.html#ae9dbcfac61016564f39ee9b13e36311c">write</a> (const T &datum)</td></tr> |
| <tr class="memdesc:ae9dbcfac61016564f39ee9b13e36311c"><td class="mdescLeft"> </td><td class="mdescRight">Writes the given piece of data into the file. <br /></td></tr> |
| <tr class="separator:ae9dbcfac61016564f39ee9b13e36311c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa96372b283916cb6a8469ce15a8b3756"><td class="memItemLeft" align="right" valign="top"><a id="aa96372b283916cb6a8469ce15a8b3756"></a> |
| uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriter.html#aa96372b283916cb6a8469ce15a8b3756">getCurrentBlockStart</a> ()</td></tr> |
| <tr class="memdesc:aa96372b283916cb6a8469ce15a8b3756"><td class="mdescLeft"> </td><td class="mdescRight">Returns the byte offset (within the current file) of the start of the current block being written. <br /></td></tr> |
| <tr class="separator:aa96372b283916cb6a8469ce15a8b3756"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ed294a4c9e3641b4cbd383ede5aedc1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriter.html#a3ed294a4c9e3641b4cbd383ede5aedc1">close</a> ()</td></tr> |
| <tr class="memdesc:a3ed294a4c9e3641b4cbd383ede5aedc1"><td class="mdescLeft"> </td><td class="mdescRight">Closes the current file. <a href="#a3ed294a4c9e3641b4cbd383ede5aedc1">More...</a><br /></td></tr> |
| <tr class="separator:a3ed294a4c9e3641b4cbd383ede5aedc1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aafa35ead8509f13cb99905fe6dfae7e0"><td class="memItemLeft" align="right" valign="top"><a id="aafa35ead8509f13cb99905fe6dfae7e0"></a> |
| const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriter.html#aafa35ead8509f13cb99905fe6dfae7e0">schema</a> () const</td></tr> |
| <tr class="memdesc:aafa35ead8509f13cb99905fe6dfae7e0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the schema for this data file. <br /></td></tr> |
| <tr class="separator:aafa35ead8509f13cb99905fe6dfae7e0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a837519693ff84da1e86e18c5c2bba885"><td class="memItemLeft" align="right" valign="top"><a id="a837519693ff84da1e86e18c5c2bba885"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriter.html#a837519693ff84da1e86e18c5c2bba885">flush</a> ()</td></tr> |
| <tr class="memdesc:a837519693ff84da1e86e18c5c2bba885"><td class="mdescLeft"> </td><td class="mdescRight">Flushes any unwritten data into the file. <br /></td></tr> |
| <tr class="separator:a837519693ff84da1e86e18c5c2bba885"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><h3>template<typename T><br /> |
| class avro::DataFileWriter< T ></h3> |
| |
| <p>An Avro datafile that can store objects of type T. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a3ed294a4c9e3641b4cbd383ede5aedc1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3ed294a4c9e3641b4cbd383ede5aedc1">◆ </a></span>close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="classavro_1_1DataFileWriter.html">avro::DataFileWriter</a>< T >::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">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Closes the current file. </p> |
| <p>Once closed this datafile object cannot be used for writing any more. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>api/<a class="el" href="DataFile_8hh_source.html">DataFile.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> |
