http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2io_2memory_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2io_2memory_8h_source.html b/docs/cpp/arrow_2io_2memory_8h_source.html new file mode 100644 index 0000000..3e7a256 --- /dev/null +++ b/docs/cpp/arrow_2io_2memory_8h_source.html @@ -0,0 +1,116 @@ +<!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.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/io/memory.h Source File</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">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_f268bcc159eae94e675c85a5c9130f48.html">io</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">memory.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="arrow_2io_2memory_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a>< span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software dis tributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Public API for different memory sharing / IO mechanisms</span></div><div class="line"><a nam e="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IO_MEMORY_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IO_MEMORY_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="interfaces_8h.html">arrow/io/interfaces.h</a>"</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="memory__pool_8h.html">arrow/memory_pool.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="arrow_2util_2visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span><a class="code" href="namespaceparquet.html#abad5a6612a34e123346ad35eb4933d80">Buffer</a>;</div><div class ="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span><a class="code" href="namespaceparquet.html#a1c3b994581f3fc6e9842eb902ef7916f">ResizableBuffer</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// \brief An output stream that writes to a resizable buffer</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_output_stream.html"> 39</a></span> <span class="keyword">class </span>ARROW_EX PORT <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>(<span class="keyword">const</span> std::shared_ptr<ResizableBuffer>& buffer);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Create(int64_t initial_capacity, <a class="code" href="classarrow_1_1_memory_pool.html"> MemoryPool</a>* pool,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::shared_ptr<BufferOutputStream>* out);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  ~<a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Implement the OutputStream interface</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">using</span> <a class="code" href="classarrow_1_1io_1_1_writable.html#a51d9feed73c33f095ca4b9f35dede84d">OutputStream::Write</a>;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Finish(std::shared_ptr<Buf fer>* result);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Reset(int64_t initial_capacity = 1024, <a class="code" href="classarrow_1_1_memory_pool.html">MemoryPool</a>* pool = <a class="code" href="namespacearrow.html#aebe81d544faaf827b8f32c5a80b99820">default_memory_pool</a>());</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_output_stream.html#aba8fe40847d143b6f69780db99d00cdd"> 71</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html#aba8fe40847d143b6f69780db99d00cdd">capacity</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> capacity_; }</div><div class="line"><a name="l 00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classarrow_1_1io_1_1_buffer_output_stream.html">BufferOutputStream</a>();</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// Ensures there is sufficient space available to write nbytes</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Reserve(int64_t nbytes);</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::shared_ptr<ResizableBuffer> buf fer_;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> is_open_;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  int64_t capacity_;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  int64_t position_;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  uint8_t* mutable_data_;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> };</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// \brief A helper class to tracks the size of allocations</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html"> 87</a></span> <span class="keyword">class </span>ARROW_EXPO RT <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html">MockOutputStream</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_output_stream.html">OutputStream</a> {</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b"> 89</a></span>  <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b">MockOutputStream</a>() : extent_bytes_written_(0) {}</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// Implement the OutputStream interface</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> 60; <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cffe"> 96</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cff e">GetExtentBytesWritten</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> extent_bytes_written_; }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  int64_t extent_bytes_written_;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> };</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html"> 103</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a> : <span class="keyword">public</span> <a class="code" href="cla ssarrow_1_1io_1_1_writable_file.html">WritableFile</a> {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a>(<span class="keyword">const</span> std::shared_ptr<Buffer>& buffer);</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  ~<a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">FixedSizeBufferWriter</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div cla ss="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Write(<span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> WriteAt(int64_t position, <span class="keyword">const</span> <span class="keywordtype">void</span>* data, int64_t nbytes) <span class="keyword">override</ span>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordtype">void</span> set_memcopy_threads(<span class="keywordtype">int</span> num_threads);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> set_memcopy_blocksize(int64_t blocksize);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">void</span> set_memcopy_threshold(int64_t threshold);</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3"> 120</a></span>  <span class="keyword">class </span>FixedSizeBufferWriterImpl;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  std::unique_ptr<FixedSizeBufferWriterImpl> <a class="code" href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3">impl_</a>;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html"> 126</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">RandomAccessFile</a> {</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  ; <span class="keyword">public</span>:</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> std::shared_ptr<Buffer>& buffer);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">explicit</span> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& buffer);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html">BufferReader</a>(<span class="keyword">const</span> uint8_t* data, int64_t size);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Close() <span class="keyword">override</span>;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Tell(int64_t* position) <span class="keyword">const override</span>;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, int64_t* bytes_read, <span class="keywordtype">void</span>* buffer) <span class="keyword">override</span>;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">// Zero copy read</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Read(int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">overrid e</span>;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, int64_t* bytes_read,</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">void</span>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadAt(int64_t position, int64_t nbytes, std::shared_ptr<Buffer>* out) <span class="keyword">override</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetSize(int64_t* size ) <span class="keyword">override</span>;</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> Seek(int64_t position) <span class="keyword">override</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordtype">bool</span> supports_zero_copy() <span class="keyword">const override</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492"> 147</a></span>  std::shared_ptr<Buffer> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492">buffer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">re turn</span> buffer_; }</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">protected</span>:</div><div class="line"><a name="l00150"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314"> 150</a></span>  std::shared_ptr<Buffer> <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314">buffer_</a>;</div><div class="line"><a name="l00151"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc"> 151</a></span>  <span class="keyword">const</span> uint8_t* <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc">data_</a>;</div><div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="classarrow_1_1i o_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6"> 152</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6">size_</a>;</div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961"> 153</a></span>  int64_t <a class="code" href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961">position_</a>;</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> };</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00158"></a><span class= "lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#endif // ARROW_IO_MEMORY_H</span></div><div class="ttc" id="classarrow_1_1io_1_1_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_output_stream.html">arrow::io::OutputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:111</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_aa1491beffa2e6b2bc025e25c67886492"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#aa1491beffa2e6b2bc025e25c67886492">arrow::io::BufferReader::buffer</a></div><div class="ttdeci">std::shared_ptr< Buffer > buffer() const</div><div class="ttdef"><b>Definition:</b> memory.h:147</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_random_access_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:127</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html">arrow::io::BufferReader</a></div><div class="ttdoc">Random access zero-copy reads on an arrow::Buffer. </div><div class="ttdef"><b>Definition:</b> memory.h:126</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_output_stream.html">arrow::io::BufferOutputStream</a></div><div class="ttdef"><b>Definition:</b> memory.h:39</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a7884a6f59fa0db820f86a861ef6851cc"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a7884a6f59fa0db820f86a861ef6851cc">arrow::io::BufferReader::data_</a></div><div class="ttdeci">const uint8_t * data_</div><div class="ttdef"><b>Definition:</b> memory.h:151</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_writable_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_writable_file.html">arrow::io::WritableFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:171</div></div> +<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:95</div></div> +<div class="ttc" id="namespacearrow_html_aebe81d544faaf827b8f32c5a80b99820"><div class="ttname"><a href="namespacearrow.html#aebe81d544faaf827b8f32c5a80b99820">arrow::default_memory_pool</a></div><div class="ttdeci">MemoryPool * default_memory_pool()</div></div> +<div class="ttc" id="interfaces_8h_html"><div class="ttname"><a href="interfaces_8h.html">interfaces.h</a></div></div> +<div class="ttc" id="namespaceparquet_html_a1c3b994581f3fc6e9842eb902ef7916f"><div class="ttname"><a href="namespaceparquet.html#a1c3b994581f3fc6e9842eb902ef7916f">parquet::ResizableBuffer</a></div><div class="ttdeci">::arrow::ResizableBuffer ResizableBuffer</div><div class="ttdef"><b>Definition:</b> memory.h:56</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_mock_output_stream_html_aeffcb55e9b83be6037d8596d116f183b"><div class="ttname"><a href="classarrow_1_1io_1_1_mock_output_stream.html#aeffcb55e9b83be6037d8596d116f183b">arrow::io::MockOutputStream::MockOutputStream</a></div><div class="ttdeci">MockOutputStream()</div><div class="ttdef"><b>Definition:</b> memory.h:89</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_mock_output_stream_html_a38536d0cd4808fd6af4f23326145cffe"><div class="ttname"><a href="classarrow_1_1io_1_1_mock_output_stream.html#a38536d0cd4808fd6af4f23326145cffe">arrow::io::MockOutputStream::GetExtentBytesWritten</a></div><div class="ttdeci">int64_t GetExtentBytesWritten() const</div><div class="ttdef"><b>Definition:</b> memory.h:96</div></div> +<div class="ttc" id="memory__pool_8h_html"><div class="ttname"><a href="memory__pool_8h.html">memory_pool.h</a></div></div> +<div class="ttc" id="classarrow_1_1io_1_1_writable_html_a51d9feed73c33f095ca4b9f35dede84d"><div class="ttname"><a href="classarrow_1_1io_1_1_writable.html#a51d9feed73c33f095ca4b9f35dede84d">arrow::io::Writable::Write</a></div><div class="ttdeci">virtual Status Write(const void *data, int64_t nbytes)=0</div></div> +<div class="ttc" id="arrow_2util_2visibility_8h_html"><div class="ttname"><a href="arrow_2util_2visibility_8h.html">visibility.h</a></div></div> +<div class="ttc" id="classarrow_1_1io_1_1_mock_output_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_mock_output_stream.html">arrow::io::MockOutputStream</a></div><div class="ttdef"><b>Definition:</b> memory.h:87</div></div> +<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_fixed_size_buffer_writer_html_a03fe73b61469276c535aa3fef56db5c3"><div class="ttname"><a href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html#a03fe73b61469276c535aa3fef56db5c3">arrow::io::FixedSizeBufferWriter::impl_</a></div><div class="ttdeci">std::unique_ptr< FixedSizeBufferWriterImpl > impl_</div><div class="ttdef"><b>Definition:</b> memory.h:120</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a245edeff7186cc5f173cda2c1e925314"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a245edeff7186cc5f173cda2c1e925314">arrow::io::BufferReader::buffer_</a></div><div class="ttdeci">std::shared_ptr< Buffer > buffer_</div><div class="ttdef"><b>Definition:</b> memory.h:150</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_output_stream_html_aba8fe40847d143b6f69780db99d00cdd"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_output_stream.html#aba8fe40847d143b6f69780db99d00cdd">arrow::io::BufferOutputStream::capacity</a></div><div class="ttdeci">int64_t capacity() const</div><div class="ttdef"><b>Definition:</b> memory.h:71</div></div> +<div class="ttc" id="classarrow_1_1_memory_pool_html"><div class="ttname"><a href="classarrow_1_1_memory_pool.html">arrow::MemoryPool</a></div><div class="ttdoc">Base class for memory allocation. </div><div class="ttdef"><b>Definition:</b> memory_pool.h:34</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_fixed_size_buffer_writer_html"><div class="ttname"><a href="classarrow_1_1io_1_1_fixed_size_buffer_writer.html">arrow::io::FixedSizeBufferWriter</a></div><div class="ttdoc">Enables random writes into a fixed-size mutable buffer. </div><div class="ttdef"><b>Definition:</b> memory.h:103</div></div> +<div class="ttc" id="classarrow_1_1_buffer_html"><div class="ttname"><a href="classarrow_1_1_buffer.html">arrow::Buffer</a></div><div class="ttdoc">Object containing a pointer to a piece of contiguous memory with a particular size. </div><div class="ttdef"><b>Definition:</b> buffer.h:50</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a38c69e817deb97bbaf521824f46e2961"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a38c69e817deb97bbaf521824f46e2961">arrow::io::BufferReader::position_</a></div><div class="ttdeci">int64_t position_</div><div class="ttdef"><b>Definition:</b> memory.h:153</div></div> +<div class="ttc" id="namespaceparquet_html_abad5a6612a34e123346ad35eb4933d80"><div class="ttname"><a href="namespaceparquet.html#abad5a6612a34e123346ad35eb4933d80">parquet::Buffer</a></div><div class="ttdeci">::arrow::Buffer Buffer</div><div class="ttdef"><b>Definition:</b> memory.h:54</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_buffer_reader_html_a3f1655cf6afa7e0799f6c6914fe570e6"><div class="ttname"><a href="classarrow_1_1io_1_1_buffer_reader.html#a3f1655cf6afa7e0799f6c6914fe570e6">arrow::io::BufferReader::size_</a></div><div class="ttdeci">int64_t size_</div><div class="ttdef"><b>Definition:</b> memory.h:152</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- 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.14 +</small></address> +<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1";></script> +<script> + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-107500873-1'); +</script> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2ipc_2reader_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2ipc_2reader_8h.html b/docs/cpp/arrow_2ipc_2reader_8h.html new file mode 100644 index 0000000..12edffe --- /dev/null +++ b/docs/cpp/arrow_2ipc_2reader_8h.html @@ -0,0 +1,150 @@ +<!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.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/ipc/reader.h File 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">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_e3cd57a4f30ba74550f913507c7f1d51.html">ipc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">reader.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <cstdint></code><br /> +<code>#include <memory></code><br /> +<code>#include "<a class="el" href="message_8h_source.html">arrow/ipc/message.h</a>"</code><br /> +<code>#include "<a class="el" href="record__batch_8h_source.html">arrow/record_batch.h</a>"</code><br /> +<code>#include "<a class="el" href="arrow_2util_2visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +</div> +<p><a href="arrow_2ipc_2reader_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Synchronous batch stream reader that reads from <a class="el" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>. <a href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">arrow::ipc::RecordBatchFileReader</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Reads the record batch file format. <a href="classarrow_1_1ipc_1_1_record_batch_file_reader.html#details">More...</a><br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespacearrow"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow.html">arrow</a></td></tr> +<tr class="memdesc:namespacearrow"><td class="mdescLeft"> </td><td class="mdescRight">Top-level namespace for Apache Arrow C++ API. <br /></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1io"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1io.html">arrow::io</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:namespacearrow_1_1ipc"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html">arrow::ipc</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:a6eae3918b2e6c0c4e1f56e083187a339"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">arrow::ipc::RecordBatchReader</a> = ::<a class="el" href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></td></tr> +<tr class="separator:a6eae3918b2e6c0c4e1f56e083187a339"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:afb612803f2eb24e01d7c3f843941e2f2"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">arrow::ipc::ReadSchema</a> (io::InputStream *stream, std::shared_ptr< Schema > *out)</td></tr> +<tr class="memdesc:afb612803f2eb24e01d7c3f843941e2f2"><td class="mdescLeft"> </td><td class="mdescRight">Read <a class="el" href="classarrow_1_1_schema.html" title="Sequence of arrow::Field objects describing the columns of a record batch or table data structure...">Schema</a> from stream serialized as a sequence of one or more IPC messages. <a href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">More...</a><br /></td></tr> +<tr class="separator:afb612803f2eb24e01d7c3f843941e2f2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a62aea9cdc78753fed7578ec36a85ab44"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">arrow::ipc::ReadRecordBatch</a> (const std::shared_ptr< Schema > &schema, io::InputStream *stream, std::shared_ptr< RecordBatch > *out)</td></tr> +<tr class="memdesc:a62aea9cdc78753fed7578ec36a85ab44"><td class="mdescLeft"> </td><td class="mdescRight">Read record batch as encapsulated IPC message with metadata size prefix and header. <a href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">More...</a><br /></td></tr> +<tr class="separator:a62aea9cdc78753fed7578ec36a85ab44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aad4a6b5e54a5f53ce83bc807a7502ecd"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#aad4a6b5e54a5f53ce83bc807a7502ecd">arrow::ipc::ReadRecordBatch</a> (const Buffer &metadata, const std::shared_ptr< Schema > &schema, io::RandomAccessFile *file, std::shared_ptr< RecordBatch > *out)</td></tr> +<tr class="memdesc:aad4a6b5e54a5f53ce83bc807a7502ecd"><td class="mdescLeft"> </td><td class="mdescRight">Read record batch from file given metadata and schema. <a href="namespacearrow_1_1ipc.html#aad4a6b5e54a5f53ce83bc807a7502ecd">More...</a><br /></td></tr> +<tr class="separator:aad4a6b5e54a5f53ce83bc807a7502ecd"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a30da9bf2286eb500b986d4584f925a8e"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a30da9bf2286eb500b986d4584f925a8e">arrow::ipc::ReadRecordBatch</a> (const Message &message, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatch > *out)</td></tr> +<tr class="memdesc:a30da9bf2286eb500b986d4584f925a8e"><td class="mdescLeft"> </td><td class="mdescRight">Read record batch from encapsulated <a class="el" href="classarrow_1_1ipc_1_1_message.html" title="An IPC message including metadata and body. ">Message</a>. <a href="namespacearrow_1_1ipc.html#a30da9bf2286eb500b986d4584f925a8e">More...</a><br /></td></tr> +<tr class="separator:a30da9bf2286eb500b986d4584f925a8e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acb7dd533f236bfe74864842b8afb3cf7"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#acb7dd533f236bfe74864842b8afb3cf7">arrow::ipc::ReadRecordBatch</a> (const Buffer &metadata, const std::shared_ptr< Schema > &schema, int max_recursion_depth, io::RandomAccessFile *file, std::shared_ptr< RecordBatch > *out)</td></tr> +<tr class="memdesc:acb7dd533f236bfe74864842b8afb3cf7"><td class="mdescLeft"> </td><td class="mdescRight">Read record batch from file given metadata and schema. <a href="namespacearrow_1_1ipc.html#acb7dd533f236bfe74864842b8afb3cf7">More...</a><br /></td></tr> +<tr class="separator:acb7dd533f236bfe74864842b8afb3cf7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ffa631df520945bd810dd8b3049ef98"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#a4ffa631df520945bd810dd8b3049ef98">arrow::ipc::ReadTensor</a> (io::InputStream *file, std::shared_ptr< Tensor > *out)</td></tr> +<tr class="memdesc:a4ffa631df520945bd810dd8b3049ef98"><td class="mdescLeft"> </td><td class="mdescRight">Read <a class="el" href="classarrow_1_1_tensor.html">arrow::Tensor</a> as encapsulated IPC message in file. <a href="namespacearrow_1_1ipc.html#a4ffa631df520945bd810dd8b3049ef98">More...</a><br /></td></tr> +<tr class="separator:a4ffa631df520945bd810dd8b3049ef98"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae3aae0f0f0319351978a0f8c7630e462"><td class="memItemLeft" align="right" valign="top">Status </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1ipc.html#ae3aae0f0f0319351978a0f8c7630e462">arrow::ipc::ReadTensor</a> (const Message &message, std::shared_ptr< Tensor > *out)</td></tr> +<tr class="memdesc:ae3aae0f0f0319351978a0f8c7630e462"><td class="mdescLeft"> </td><td class="mdescRight">EXPERIMENTAL: Read <a class="el" href="classarrow_1_1_tensor.html">arrow::Tensor</a> from IPC message. <a href="namespacearrow_1_1ipc.html#ae3aae0f0f0319351978a0f8c7630e462">More...</a><br /></td></tr> +<tr class="separator:ae3aae0f0f0319351978a0f8c7630e462"><td class="memSeparator" colspan="2"> </td></tr> +</table> +</div><!-- contents --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- 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.14 +</small></address> +<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1";></script> +<script> + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-107500873-1'); +</script> +</body> +</html> http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2ipc_2reader_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2ipc_2reader_8h_source.html b/docs/cpp/arrow_2ipc_2reader_8h_source.html new file mode 100644 index 0000000..818f634 --- /dev/null +++ b/docs/cpp/arrow_2ipc_2reader_8h_source.html @@ -0,0 +1,109 @@ +<!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.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Apache Arrow (C++): /arrow/cpp/src/arrow/ipc/reader.h Source File</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">Apache Arrow (C++) + </div> + <div id="projectbrief">A columnar in-memory analytics layer designed to accelerate big data.</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_4f683177589ce7b8fe2ef6d807198da3.html">arrow</a></li><li class="navelem"><a class="el" href="dir_e3cd57a4f30ba74550f913507c7f1d51.html">ipc</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">reader.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="arrow_2ipc_2reader_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// or more contributor license agreements. See the NOTICE file</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// distributed with this work for additional information</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// regarding copyright ownership. The ASF licenses this file</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// to you under the Apache License, Version 2.0 (the</span></div><div class="line"><a name="l00006"></a> <span class="lineno"> 6</span> <span class="comment">// "License"); you may not use this file except in compliance</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// with the License. You may obtain a copy of the License at</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Unless required by applicable law or agreed to in writing,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// software di stributed under the License is distributed on an</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// KIND, either express or implied. See the License for the</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// specific language governing permissions and limitations</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// under the License.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Read Arrow files and streams</span></div><div class="line"><a name="l00019"></a><span class ="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ARROW_IPC_READER_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define ARROW_IPC_READER_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <cstdint></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="message_8h.html">arrow/ipc/message.h</a>"</span></div><div class="line"><a na me="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="record__batch_8h.html">arrow/record_batch.h</a>"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="arrow_2util_2visibility_8h.html">arrow/util/visibility.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">class </span><a class="code" href="namespaceparquet.html#abad5a6612a34e123346ad35eb4933d80">Buffer</a>;</div><div class="line"><a name="l00033"></ a><span class="lineno"> 33</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>Status;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span>Tensor;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span>io {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">class </span>InputStream;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">class </span>RandomAccessFile;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class ="line"><a name="l00042"></a><span class="lineno"> 42</span> } <span class="comment">// namespace io</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">namespace </span>ipc {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339"> 46</a></span> <span class="keyword">using</span> <a class="code" href="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a> = <a class="code" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">::arrow::RecordBatchReader</a>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="class arrow_1_1ipc_1_1_record_batch_stream_reader.html"> 54</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a> : <span class="keyword">public</span> <a class="code" href="classarrow_1_1_record_batch_reader.html">RecordBatchReader</a> {</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(std::unique_ptr<Mess ageReader> message_reader,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream, std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::InputStream>& stream,</div><div class="line"><a name="l00079"></a><sp an class="lineno"> 79</span>  std::shared_ptr<RecordBatchReader>* out);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::shared_ptr<Schema> <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ReadNext(std::shared_ptr<RecordBatch>* batch) <span class="keyword">override</span>;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">private</span>:</div><div class="line"><a name= "l00087"></a><span class="lineno"> 87</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">RecordBatchStreamReader</a>();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">class </span><a class="code" href="arrow_2util_2visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchStreamReaderImpl;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::unique_ptr<RecordBatchStreamReaderImpl> impl_;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> };</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html"> 94</a></span> <span class="keywo rd">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a> {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  ~<a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a>();</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"> <a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file, int64_t footer_offset,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& file,</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  st d::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Open(<span class="keyword">const</span> std::shared_ptr<io::RandomAccessFile>& file,</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  int64_t footer_offset,</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  std::shared_ptr<RecordBatchFileReader>* reader);</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  std::shared_ptr<Schema> <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>() <span cl ass="keyword">const</span>;</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">int</span> num_record_batches() <span class="keyword">const</span>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">MetadataVersion</a> version() <span class="keyword">const</span>;</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keywordtype">int</span> i, std::shared_p tr<RecordBatch>* batch);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <a class="code" href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">RecordBatchFileReader</a>();</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">class </span><a class="code" href="arrow_2util_2visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a> RecordBatchFileReaderImpl;</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  std::unique_ptr<RecordBatchFileReaderImpl> impl_;</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> };</div ><div class="line"><a name="l00162"></a><span class="lineno"> >162</span> </div><div class="line"><a name="l00163"></a><span >class="lineno"> 163</span> <span class="comment">// Generic read >functions; does not copy data if the input supports zero copy >reads</span></div><div class="line"><a name="l00164"></a><span >class="lineno"> 164</span> </div><div class="line"><a >name="l00174"></a><span class="lineno"> >174</span> ARROW_EXPORT</div><div class="line"><a >name="l00175"></a><span class="lineno"> 175</span> <a class="code" >href="classarrow_1_1_status.html">Status</a> <a class="code" >href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">ReadSchema</a>(<a > class="code" >href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream, >std::shared_ptr<Schema>* out);</div><div class="line"><a >name="l00176"></a><span class="lineno"> 176</span> </div><div >class="line"><a name="l00184"></a><span class="lineno"> 184</span> ARR OW_EXPORT</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, <a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* stream,</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> ARROW_EXPORT</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" h ref="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& metadata, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file, std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> ARROW_EXPORT</div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7 578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_message.html">Message</a>& message, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> ARROW_EXPORT</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">ReadRecordBatch</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_buffer.html">Buffer</a>& metada ta, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  <span class="keywordtype">int</span> max_recursion_depth, <a class="code" href="classarrow_1_1io_1_1_random_access_file.html">io::RandomAccessFile</a>* file,</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  std::shared_ptr<RecordBatch>* out);</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> ARROW_EXPORT</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a4ffa631df520945bd810dd8b3049ef98">ReadTensor</a> (<a class="code" href="classarrow_1_1io_1_1_input_stream.html">io::InputStream</a>* file, std::shared_ptr<Tensor>* out);</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> ARROW_EXPORT</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <a class="code" href="classarrow_1_1_status.html">Status</a> <a class="code" href="namespacearrow_1_1ipc.html#a4ffa631df520945bd810dd8b3049ef98">ReadTensor</a>(<span class="keyword">const</span> <a class="code" href="classarrow_1_1ipc_1_1_message.html">Message</a>& message, std::shared_ptr<Tensor>* out);</div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> </div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> } <span class="comment">// namespace ipc</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</spa n> } <span class="comment">// namespace arrow</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="preprocessor">#endif // ARROW_IPC_READER_H</span></div><div class="ttc" id="classarrow_1_1ipc_1_1_message_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_message.html">arrow::ipc::Message</a></div><div class="ttdoc">An IPC message including metadata and body. </div><div class="ttdef"><b>Definition:</b> message.h:71</div></div> +<div class="ttc" id="classarrow_1_1_record_batch_reader_html"><div class="ttname"><a href="classarrow_1_1_record_batch_reader.html">arrow::RecordBatchReader</a></div><div class="ttdoc">Abstract interface for reading stream of record batches. </div><div class="ttdef"><b>Definition:</b> record_batch.h:166</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_input_stream_html"><div class="ttname"><a href="classarrow_1_1io_1_1_input_stream.html">arrow::io::InputStream</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:116</div></div> +<div class="ttc" id="classarrow_1_1io_1_1_random_access_file_html"><div class="ttname"><a href="classarrow_1_1io_1_1_random_access_file.html">arrow::io::RandomAccessFile</a></div><div class="ttdef"><b>Definition:</b> interfaces.h:127</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_a4ffa631df520945bd810dd8b3049ef98"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a4ffa631df520945bd810dd8b3049ef98">arrow::ipc::ReadTensor</a></div><div class="ttdeci">Status ReadTensor(io::InputStream *file, std::shared_ptr< Tensor > *out)</div><div class="ttdoc">Read arrow::Tensor as encapsulated IPC message in file. </div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_a62aea9cdc78753fed7578ec36a85ab44"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a62aea9cdc78753fed7578ec36a85ab44">arrow::ipc::ReadRecordBatch</a></div><div class="ttdeci">Status ReadRecordBatch(const std::shared_ptr< Schema > &schema, io::InputStream *stream, std::shared_ptr< RecordBatch > *out)</div><div class="ttdoc">Read record batch as encapsulated IPC message with metadata size prefix and header. </div></div> +<div class="ttc" id="message_8h_html"><div class="ttname"><a href="message_8h.html">message.h</a></div></div> +<div class="ttc" id="classarrow_1_1_status_html"><div class="ttname"><a href="classarrow_1_1_status.html">arrow::Status</a></div><div class="ttdef"><b>Definition:</b> status.h:95</div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_stream_reader_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_stream_reader.html">arrow::ipc::RecordBatchStreamReader</a></div><div class="ttdoc">Synchronous batch stream reader that reads from io::InputStream. </div><div class="ttdef"><b>Definition:</b> reader.h:54</div></div> +<div class="ttc" id="classarrow_1_1ipc_1_1_record_batch_file_reader_html"><div class="ttname"><a href="classarrow_1_1ipc_1_1_record_batch_file_reader.html">arrow::ipc::RecordBatchFileReader</a></div><div class="ttdoc">Reads the record batch file format. </div><div class="ttdef"><b>Definition:</b> reader.h:94</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_a6eae3918b2e6c0c4e1f56e083187a339"><div class="ttname"><a href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">arrow::ipc::RecordBatchReader</a></div><div class="ttdeci">::arrow::RecordBatchReader RecordBatchReader</div><div class="ttdef"><b>Definition:</b> reader.h:46</div></div> +<div class="ttc" id="record__batch_8h_html"><div class="ttname"><a href="record__batch_8h.html">record_batch.h</a></div></div> +<div class="ttc" id="arrow_2util_2visibility_8h_html"><div class="ttname"><a href="arrow_2util_2visibility_8h.html">visibility.h</a></div></div> +<div class="ttc" id="namespacearrow_html"><div class="ttname"><a href="namespacearrow.html">arrow</a></div><div class="ttdoc">Top-level namespace for Apache Arrow C++ API. </div><div class="ttdef"><b>Definition:</b> adapter.h:32</div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_aa5d7ec68a8c707271bab98af9bc0ac77"><div class="ttname"><a href="namespacearrow_1_1ipc.html#aa5d7ec68a8c707271bab98af9bc0ac77">arrow::ipc::MetadataVersion</a></div><div class="ttdeci">MetadataVersion</div><div class="ttdef"><b>Definition:</b> message.h:46</div></div> +<div class="ttc" id="arrow_2util_2visibility_8h_html_a843cb8dccea68a22a2b9995605cb5a74"><div class="ttname"><a href="arrow_2util_2visibility_8h.html#a843cb8dccea68a22a2b9995605cb5a74">ARROW_NO_EXPORT</a></div><div class="ttdeci">#define ARROW_NO_EXPORT</div><div class="ttdef"><b>Definition:</b> visibility.h:42</div></div> +<div class="ttc" id="namespacearrow_html_a97ac72c2a07228577c1d38b7747941a9"><div class="ttname"><a href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">arrow::schema</a></div><div class="ttdeci">std::shared_ptr< Schema > schema(const std::vector< std::shared_ptr< Field >> &fields, const std::shared_ptr< const KeyValueMetadata > &metadata=NULLPTR)</div><div class="ttdoc">Create a Schema instance. </div></div> +<div class="ttc" id="namespacearrow_1_1ipc_html_afb612803f2eb24e01d7c3f843941e2f2"><div class="ttname"><a href="namespacearrow_1_1ipc.html#afb612803f2eb24e01d7c3f843941e2f2">arrow::ipc::ReadSchema</a></div><div class="ttdeci">Status ReadSchema(io::InputStream *stream, std::shared_ptr< Schema > *out)</div><div class="ttdoc">Read Schema from stream serialized as a sequence of one or more IPC messages. </div></div> +<div class="ttc" id="classarrow_1_1_buffer_html"><div class="ttname"><a href="classarrow_1_1_buffer.html">arrow::Buffer</a></div><div class="ttdoc">Object containing a pointer to a piece of contiguous memory with a particular size. </div><div class="ttdef"><b>Definition:</b> buffer.h:50</div></div> +<div class="ttc" id="namespaceparquet_html_abad5a6612a34e123346ad35eb4933d80"><div class="ttname"><a href="namespaceparquet.html#abad5a6612a34e123346ad35eb4933d80">parquet::Buffer</a></div><div class="ttdeci">::arrow::Buffer Buffer</div><div class="ttdef"><b>Definition:</b> memory.h:54</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- 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.14 +</small></address> +<script async src="https://www.googletagmanager.com/gtag/js?id=UA-107500873-1";></script> +<script> + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'UA-107500873-1'); +</script> +</body> +</html>
