Google Git
Sign in
apache/avro/refs/heads/asf-site/./docs/1.11.1/api/cpp/html/classavro_1_1DataFileWriterBase.html
blob: 6405cedb053f7825bc35e99a396f725fbcf12185 [file]
<!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::DataFileWriterBase 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&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>
<!-- 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_1DataFileWriterBase.html">DataFileWriterBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classavro_1_1DataFileWriterBase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">avro::DataFileWriterBase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Type-independent portion of <a class="el" href="classavro_1_1DataFileWriter.html" title="An Avro datafile that can store objects of type T.">DataFileWriter</a>.
<a href="classavro_1_1DataFileWriterBase.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DataFile_8hh_source.html">DataFile.hh</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for avro::DataFileWriterBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classavro_1_1DataFileWriterBase.png" alt=""/>
</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:ae4f75607d3861cf2abf5a7a4e7f38bf6"><td class="memItemLeft" align="right" valign="top"><a id="ae4f75607d3861cf2abf5a7a4e7f38bf6"></a>
<a class="el" href="classavro_1_1Encoder.html">Encoder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#ae4f75607d3861cf2abf5a7a4e7f38bf6">encoder</a> () const</td></tr>
<tr class="memdesc:ae4f75607d3861cf2abf5a7a4e7f38bf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current encoder for this writer. <br /></td></tr>
<tr class="separator:ae4f75607d3861cf2abf5a7a4e7f38bf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9e754b44700f08f5322611b65ce7c6dc"><td class="memItemLeft" align="right" valign="top"><a id="a9e754b44700f08f5322611b65ce7c6dc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#a9e754b44700f08f5322611b65ce7c6dc">syncIfNeeded</a> ()</td></tr>
<tr class="memdesc:a9e754b44700f08f5322611b65ce7c6dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the buffer has sufficient data for a sync to be inserted. <br /></td></tr>
<tr class="separator:a9e754b44700f08f5322611b65ce7c6dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6e3658e2e6bd48ad6cad9c1f2aa9ba"><td class="memItemLeft" align="right" valign="top"><a id="adc6e3658e2e6bd48ad6cad9c1f2aa9ba"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#adc6e3658e2e6bd48ad6cad9c1f2aa9ba">getCurrentBlockStart</a> () const</td></tr>
<tr class="memdesc:adc6e3658e2e6bd48ad6cad9c1f2aa9ba"><td class="mdescLeft">&#160;</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:adc6e3658e2e6bd48ad6cad9c1f2aa9ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cf6769404775763a9be7f84d0673541"><td class="memItemLeft" align="right" valign="top"><a id="a9cf6769404775763a9be7f84d0673541"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#a9cf6769404775763a9be7f84d0673541">incr</a> ()</td></tr>
<tr class="memdesc:a9cf6769404775763a9be7f84d0673541"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increments the object count. <br /></td></tr>
<tr class="separator:a9cf6769404775763a9be7f84d0673541"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a680f12381f5a706931357adc990a540f"><td class="memItemLeft" align="right" valign="top"><a id="a680f12381f5a706931357adc990a540f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#a680f12381f5a706931357adc990a540f">DataFileWriterBase</a> (const char *filename, const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &amp;<a class="el" href="classavro_1_1DataFileWriterBase.html#a5738729ceee2eed14e7f87b59b4715c3">schema</a>, size_t syncInterval, <a class="el" href="namespaceavro.html#a348c1fae0c6b9d7524b00be30a2746b2">Codec</a> codec=NULL_CODEC)</td></tr>
<tr class="memdesc:a680f12381f5a706931357adc990a540f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a data file writer with the given sync interval and name. <br /></td></tr>
<tr class="separator:a680f12381f5a706931357adc990a540f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba44840553e30203ba3fb6d78303b55b"><td class="memItemLeft" align="right" valign="top"><a id="aba44840553e30203ba3fb6d78303b55b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>DataFileWriterBase</b> (std::unique_ptr&lt; <a class="el" href="classavro_1_1OutputStream.html">OutputStream</a> &gt; outputStream, const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &amp;<a class="el" href="classavro_1_1DataFileWriterBase.html#a5738729ceee2eed14e7f87b59b4715c3">schema</a>, size_t syncInterval, <a class="el" href="namespaceavro.html#a348c1fae0c6b9d7524b00be30a2746b2">Codec</a> codec)</td></tr>
<tr class="separator:aba44840553e30203ba3fb6d78303b55b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc2bf032070c962eee3628abbb062edf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#abc2bf032070c962eee3628abbb062edf">close</a> ()</td></tr>
<tr class="memdesc:abc2bf032070c962eee3628abbb062edf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the current file. <a href="classavro_1_1DataFileWriterBase.html#abc2bf032070c962eee3628abbb062edf">More...</a><br /></td></tr>
<tr class="separator:abc2bf032070c962eee3628abbb062edf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5738729ceee2eed14e7f87b59b4715c3"><td class="memItemLeft" align="right" valign="top"><a id="a5738729ceee2eed14e7f87b59b4715c3"></a>
const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#a5738729ceee2eed14e7f87b59b4715c3">schema</a> () const</td></tr>
<tr class="memdesc:a5738729ceee2eed14e7f87b59b4715c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the schema for this data file. <br /></td></tr>
<tr class="separator:a5738729ceee2eed14e7f87b59b4715c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c398864f93cb3e8ad2e8e5ac3ea61e8"><td class="memItemLeft" align="right" valign="top"><a id="a2c398864f93cb3e8ad2e8e5ac3ea61e8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileWriterBase.html#a2c398864f93cb3e8ad2e8e5ac3ea61e8">flush</a> ()</td></tr>
<tr class="memdesc:a2c398864f93cb3e8ad2e8e5ac3ea61e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flushes any unwritten data into the file. <br /></td></tr>
<tr class="separator:a2c398864f93cb3e8ad2e8e5ac3ea61e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Type-independent portion of <a class="el" href="classavro_1_1DataFileWriter.html" title="An Avro datafile that can store objects of type T.">DataFileWriter</a>. </p>
<p>At any given point in time, at most one file can be written using this object. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abc2bf032070c962eee3628abbb062edf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc2bf032070c962eee3628abbb062edf">&#9670;&nbsp;</a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void avro::DataFileWriterBase::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>