http://git-wip-us.apache.org/repos/asf/arrow-site/blob/f508ee59/docs/cpp/arrow_2flight_2client_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2flight_2client_8h.html b/docs/cpp/arrow_2flight_2client_8h.html new file mode 100644 index 0000000..fa09eb5 --- /dev/null +++ b/docs/cpp/arrow_2flight_2client_8h.html @@ -0,0 +1,115 @@ +<!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/flight/client.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_37f45626ebdd1e7beb459bd556ff96f5.html">flight</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> </div> + <div class="headertitle"> +<div class="title">client.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <memory></code><br /> +<code>#include <string></code><br /> +<code>#include <vector></code><br /> +<code>#include "<a class="el" href="arrow_2status_8h_source.html">arrow/status.h</a>"</code><br /> +<code>#include "<a class="el" href="arrow_2util_2visibility_8h_source.html">arrow/util/visibility.h</a>"</code><br /> +<code>#include "<a class="el" href="arrow_2flight_2types_8h_source.html">arrow/flight/types.h</a>"</code><br /> +</div> +<p><a href="arrow_2flight_2client_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_1flight_1_1_flight_client.html">arrow::flight::FlightClient</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Client class for Arrow Flight RPC services (gRPC-based). <a href="classarrow_1_1flight_1_1_flight_client.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_1flight"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1flight.html">arrow::flight</a></td></tr> +<tr class="separator:"><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_2flight_2client_8h_source.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2flight_2client_8h_source.html b/docs/cpp/arrow_2flight_2client_8h_source.html new file mode 100644 index 0000000..59f224d --- /dev/null +++ b/docs/cpp/arrow_2flight_2client_8h_source.html @@ -0,0 +1,102 @@ +<!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/flight/client.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_37f45626ebdd1e7beb459bd556ff96f5.html">flight</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">client.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="arrow_2flight_2client_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 distributed 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="l00019"></a><span class="lineno"> 19</span> <span class="comment">// considered experimental for now</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#pragma once</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 <memory></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="arrow_2status_8h.html">arrow/status.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="preprocessor">#include "<a >class="code" >href="arrow_2flight_2types_8h.html">arrow/flight/types.h</a>"</span></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">namespace </span><a >class="code" href="namespacearrow.html">arrow</a> {</div><div class="line"><a >name="l00033"></a><span class="lineno"> 33</span> </div><div >class="line"><a name="l00034"></a><span class="lineno"> >34</span> <span class="keyword">class </span>RecordBatch;</div><div >class="line"><a name="l00035"> </a><span class="lineno"> 35</span> <span class="keyword">class </span><a class="code" href="namespacearrow_1_1ipc.html#a6eae3918b2e6c0c4e1f56e083187a339">RecordBatchReader</a>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>Schema;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespacearrow_1_1flight.html"> 38</a></span> <span class="keyword">namespace </span>flight {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classarrow_1_1flight_1_1_flight_client.html"> 42</a></span> <span class="keyword">class </span>ARROW_EXPORT <a class="code" href="classarrow_1_1flight_1_1_flight_client.html">FlightClient</a> {</div><div class="line"><a name="l00043"></ a><span class="lineno"> 43</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  ~<a class="code" href="classarrow_1_1flight_1_1_flight_client.html">FlightClient</a>();</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">static</span> <a class="code" href="classarrow_1_1_status.html">Status</a> Connect(<span class="keyword">const</span> std::string& host, <span class="keywordtype">int</span> port,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::unique_ptr<FlightClient>* client);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classarrow_1_1_status.html ">Status</a> DoAction(<span class="keyword">const</span> <a class="code" href="structarrow_1_1flight_1_1_action.html">Action</a>& action, std::unique_ptr<ResultStream>* results);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ListActions(std::vector<ActionType>* actions);</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> GetFlightInfo(<span class="keyword">const</span> <a class="code" href="structarrow_1_1flight_1_1_flight_descriptor.html">FlightDescriptor</a>& descriptor,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  std::unique_ptr<FlightInfo& gt;* info);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ListFlights(std::unique_ptr<FlightListing>* listing);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> ListFlights(<span class="keyword">const</span> <a class="code" href="structarrow_1_1flight_1_1_criteria.html">Criteria</a>& criteria, std::unique_ptr<FlightListing>* listing);</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</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> DoGet(<span class="keyword">const</span> <a class ="code" href="structarrow_1_1flight_1_1_ticket.html">Ticket</a>& ticket, <span class="keyword">const</span> std::shared_ptr<Schema>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>,</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::unique_ptr<RecordBatchReader>* stream);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classarrow_1_1_status.html">Status</a> DoPut(<span class="keyword">const</span> <a class="code" href="classarrow_1_1_schema.html">Schema</a>& <a class="code" href="namespacearrow.html#a97ac72c2a07228577c1d38b7747941a9">schema</a>, std::unique_ptr<FlightPutWriter>* stream);</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span cla ss="lineno"> 103</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classarrow_1_1flight_1_1_flight_client.html">FlightClient</a>();</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">class </span>FlightClientImpl;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::unique_ptr<FlightClientImpl> impl_;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</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> } <span class="comment">// namespace flight</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">// namespace arrow</span></div><div class="ttc" id="classarrow_1_1flight_ 1_1_flight_client_html"><div class="ttname"><a href="classarrow_1_1flight_1_1_flight_client.html">arrow::flight::FlightClient</a></div><div class="ttdoc">Client class for Arrow Flight RPC services (gRPC-based). </div><div class="ttdef"><b>Definition:</b> client.h:42</div></div> +<div class="ttc" id="structarrow_1_1flight_1_1_action_html"><div class="ttname"><a href="structarrow_1_1flight_1_1_action.html">arrow::flight::Action</a></div><div class="ttdoc">An action to perform with the DoAction RPC. </div><div class="ttdef"><b>Definition:</b> types.h:54</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="arrow_2flight_2types_8h_html"><div class="ttname"><a href="arrow_2flight_2types_8h.html">types.h</a></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="arrow_2util_2visibility_8h_html"><div class="ttname"><a href="arrow_2util_2visibility_8h.html">visibility.h</a></div></div> +<div class="ttc" id="structarrow_1_1flight_1_1_criteria_html"><div class="ttname"><a href="structarrow_1_1flight_1_1_criteria.html">arrow::flight::Criteria</a></div><div class="ttdoc">Opaque selection critera for ListFlights RPC. </div><div class="ttdef"><b>Definition:</b> types.h:48</div></div> +<div class="ttc" id="classarrow_1_1_schema_html"><div class="ttname"><a href="classarrow_1_1_schema.html">arrow::Schema</a></div><div class="ttdoc">Sequence of arrow::Field objects describing the columns of a record batch or table data structure...</div><div class="ttdef"><b>Definition:</b> type.h:773</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="structarrow_1_1flight_1_1_ticket_html"><div class="ttname"><a href="structarrow_1_1flight_1_1_ticket.html">arrow::flight::Ticket</a></div><div class="ttdoc">Data structure providing an opaque identifier or credential to use when requesting a data stream with...</div><div class="ttdef"><b>Definition:</b> types.h:92</div></div> +<div class="ttc" id="arrow_2status_8h_html"><div class="ttname"><a href="arrow_2status_8h.html">status.h</a></div></div> +<div class="ttc" id="structarrow_1_1flight_1_1_flight_descriptor_html"><div class="ttname"><a href="structarrow_1_1flight_1_1_flight_descriptor.html">arrow::flight::FlightDescriptor</a></div><div class="ttdoc">A request to retrieve or generate a dataset. </div><div class="ttdef"><b>Definition:</b> types.h:71</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><!-- 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_2flight_2types_8h.html ---------------------------------------------------------------------- diff --git a/docs/cpp/arrow_2flight_2types_8h.html b/docs/cpp/arrow_2flight_2types_8h.html new file mode 100644 index 0000000..dd05c53 --- /dev/null +++ b/docs/cpp/arrow_2flight_2types_8h.html @@ -0,0 +1,156 @@ +<!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/flight/types.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_37f45626ebdd1e7beb459bd556ff96f5.html">flight</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> </div> + <div class="headertitle"> +<div class="title">types.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 <string></code><br /> +<code>#include <utility></code><br /> +<code>#include <vector></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_2flight_2types_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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_action_type.html">arrow::flight::ActionType</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A type of action that can be performed with the DoAction RPC. <a href="structarrow_1_1flight_1_1_action_type.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_criteria.html">arrow::flight::Criteria</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Opaque selection critera for ListFlights RPC. <a href="structarrow_1_1flight_1_1_criteria.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_action.html">arrow::flight::Action</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An action to perform with the DoAction RPC. <a href="structarrow_1_1flight_1_1_action.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_result.html">arrow::flight::Result</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Opaque result returned after executing an action. <a href="structarrow_1_1flight_1_1_result.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_put_result.html">arrow::flight::PutResult</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A message received after completing a DoPut stream. <a href="structarrow_1_1flight_1_1_put_result.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_flight_descriptor.html">arrow::flight::FlightDescriptor</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A request to retrieve or generate a dataset. <a href="structarrow_1_1flight_1_1_flight_descriptor.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_ticket.html">arrow::flight::Ticket</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data structure providing an opaque identifier or credential to use when requesting a data stream with the DoGet RPC. <a href="structarrow_1_1flight_1_1_ticket.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_location.html">arrow::flight::Location</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A host location (hostname and port) <a href="structarrow_1_1flight_1_1_location.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_flight_endpoint.html">arrow::flight::FlightEndpoint</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A flight ticket and list of locations where the ticket can be redeemed. <a href="structarrow_1_1flight_1_1_flight_endpoint.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_1flight_1_1_flight_info.html">arrow::flight::FlightInfo</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The access coordinates for retireval of a dataset, returned by GetFlightInfo. <a href="classarrow_1_1flight_1_1_flight_info.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">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarrow_1_1flight_1_1_flight_info_1_1_data.html">arrow::flight::FlightInfo::Data</a></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_1flight_1_1_flight_put_writer.html">arrow::flight::FlightPutWriter</a></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_1flight_1_1_flight_listing.html">arrow::flight::FlightListing</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An iterator to <a class="el" href="classarrow_1_1flight_1_1_flight_info.html" title="The access coordinates for retireval of a dataset, returned by GetFlightInfo. ">FlightInfo</a> instances returned by ListFlights. <a href="classarrow_1_1flight_1_1_flight_listing.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_1flight_1_1_result_stream.html">arrow::flight::ResultStream</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An iterator to <a class="el" href="structarrow_1_1flight_1_1_result.html" title="Opaque result returned after executing an action. ">Result</a> instances returned by DoAction. <a href="classarrow_1_1flight_1_1_result_stream.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_1flight_1_1_simple_flight_listing.html">arrow::flight::SimpleFlightListing</a></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_1flight_1_1_simple_result_stream.html">arrow::flight::SimpleResultStream</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="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_1flight"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearrow_1_1flight.html">arrow::flight</a></td></tr> +<tr class="separator:"><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>
