You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by uw...@apache.org on 2017/06/27 10:00:28 UTC
[38/51] [partial] arrow-site git commit: Rerender docs
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/d37aab64/docs/cpp/class_eviction_policy.html
----------------------------------------------------------------------
diff --git a/docs/cpp/class_eviction_policy.html b/docs/cpp/class_eviction_policy.html
new file mode 100644
index 0000000..f4a246f
--- /dev/null
+++ b/docs/cpp/class_eviction_policy.html
@@ -0,0 +1,345 @@
+<!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.11"/>
+<title>Apache Arrow (C++): EvictionPolicy Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</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.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="annotated.html"><span>Class List</span></a></li>
+ <li><a href="classes.html"><span>Class Index</span></a></li>
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class Members</span></a></li>
+ </ul>
+ </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><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> |
+<a href="class_eviction_policy-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">EvictionPolicy Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>The eviction policy.
+ <a href="class_eviction_policy.html#details">More...</a></p>
+
+<p><code>#include <<a class="el" href="eviction__policy_8h_source.html">eviction_policy.h</a>></code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a43d37b60cd7b25888c6ae8cd03f3f546"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eviction_policy.html#a43d37b60cd7b25888c6ae8cd03f3f546">EvictionPolicy</a> (<a class="el" href="struct_plasma_store_info.html">PlasmaStoreInfo</a> *store_info)</td></tr>
+<tr class="memdesc:a43d37b60cd7b25888c6ae8cd03f3f546"><td class="mdescLeft"> </td><td class="mdescRight">Construct an eviction policy. <a href="#a43d37b60cd7b25888c6ae8cd03f3f546">More...</a><br /></td></tr>
+<tr class="separator:a43d37b60cd7b25888c6ae8cd03f3f546"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a506e8b57e5241949ee0d92f0bfd1b95f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eviction_policy.html#a506e8b57e5241949ee0d92f0bfd1b95f">object_created</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id)</td></tr>
+<tr class="memdesc:a506e8b57e5241949ee0d92f0bfd1b95f"><td class="mdescLeft"> </td><td class="mdescRight">This method will be called whenever an object is first created in order to add it to the LRU cache. <a href="#a506e8b57e5241949ee0d92f0bfd1b95f">More...</a><br /></td></tr>
+<tr class="separator:a506e8b57e5241949ee0d92f0bfd1b95f"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:aef0a2efdc4ae24279237d70506bcdf91"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eviction_policy.html#aef0a2efdc4ae24279237d70506bcdf91">require_space</a> (int64_t size, std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > *objects_to_evict)</td></tr>
+<tr class="memdesc:aef0a2efdc4ae24279237d70506bcdf91"><td class="mdescLeft"> </td><td class="mdescRight">This method will be called when the Plasma store needs more space, perhaps to create a new object. <a href="#aef0a2efdc4ae24279237d70506bcdf91">More...</a><br /></td></tr>
+<tr class="separator:aef0a2efdc4ae24279237d70506bcdf91"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a06dfd076bfb453e68e64b56438e4cefe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eviction_policy.html#a06dfd076bfb453e68e64b56438e4cefe">begin_object_access</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id, std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > *objects_to_evict)</td></tr>
+<tr class="memdesc:a06dfd076bfb453e68e64b56438e4cefe"><td class="mdescLeft"> </td><td class="mdescRight">This method will be called whenever an unused object in the Plasma store starts to be used. <a href="#a06dfd076bfb453e68e64b56438e4cefe">More...</a><br /></td></tr>
+<tr class="separator:a06dfd076bfb453e68e64b56438e4cefe"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:ad2b0f79616d42f75d02551a512ed0dd1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eviction_policy.html#ad2b0f79616d42f75d02551a512ed0dd1">end_object_access</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id, std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > *objects_to_evict)</td></tr>
+<tr class="memdesc:ad2b0f79616d42f75d02551a512ed0dd1"><td class="mdescLeft"> </td><td class="mdescRight">This method will be called whenever an object in the Plasma store that was being used is no longer being used. <a href="#ad2b0f79616d42f75d02551a512ed0dd1">More...</a><br /></td></tr>
+<tr class="separator:ad2b0f79616d42f75d02551a512ed0dd1"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a722e0d4701f4af72d1be794c45f509fd"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eviction_policy.html#a722e0d4701f4af72d1be794c45f509fd">choose_objects_to_evict</a> (int64_t num_bytes_required, std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > *objects_to_evict)</td></tr>
+<tr class="memdesc:a722e0d4701f4af72d1be794c45f509fd"><td class="mdescLeft"> </td><td class="mdescRight">Choose some objects to evict from the Plasma store. <a href="#a722e0d4701f4af72d1be794c45f509fd">More...</a><br /></td></tr>
+<tr class="separator:a722e0d4701f4af72d1be794c45f509fd"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><p>The eviction policy. </p>
+</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
+<a class="anchor" id="a43d37b60cd7b25888c6ae8cd03f3f546"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">EvictionPolicy::EvictionPolicy </td>
+ <td>(</td>
+ <td class="paramtype"><a class="el" href="struct_plasma_store_info.html">PlasmaStoreInfo</a> * </td>
+ <td class="paramname"><em>store_info</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+<p>Construct an eviction policy. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">store_info</td><td>Information about the Plasma store that is exposed to the eviction policy. </td></tr>
+ </table>
+ </dd>
+</dl>
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a class="anchor" id="a06dfd076bfb453e68e64b56438e4cefe"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void EvictionPolicy::begin_object_access </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > * </td>
+ <td class="paramname"><em>objects_to_evict</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>This method will be called whenever an unused object in the Plasma store starts to be used. </p>
+<p>When this method is called, the eviction policy will assume that the objects chosen to be evicted will in fact be evicted from the Plasma store by the caller.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID of the object that is now being used. </td></tr>
+ <tr><td class="paramname">objects_to_evict</td><td>The object IDs that were chosen for eviction will be stored into this vector. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Void. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a722e0d4701f4af72d1be794c45f509fd"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int64_t EvictionPolicy::choose_objects_to_evict </td>
+ <td>(</td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>num_bytes_required</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > * </td>
+ <td class="paramname"><em>objects_to_evict</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Choose some objects to evict from the Plasma store. </p>
+<p>When this method is called, the eviction policy will assume that the objects chosen to be evicted will in fact be evicted from the Plasma store by the caller.</p>
+<dl class="section note"><dt>Note</dt><dd>This method is not part of the API. It is exposed in the header file only for testing.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">num_bytes_required</td><td>The number of bytes of space to try to free up. </td></tr>
+ <tr><td class="paramname">objects_to_evict</td><td>The object IDs that were chosen for eviction will be stored into this vector. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The total number of bytes of space chosen to be evicted. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="ad2b0f79616d42f75d02551a512ed0dd1"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void EvictionPolicy::end_object_access </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > * </td>
+ <td class="paramname"><em>objects_to_evict</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>This method will be called whenever an object in the Plasma store that was being used is no longer being used. </p>
+<p>When this method is called, the eviction policy will assume that the objects chosen to be evicted will in fact be evicted from the Plasma store by the caller.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID of the object that is no longer being used. </td></tr>
+ <tr><td class="paramname">objects_to_evict</td><td>The object IDs that were chosen for eviction will be stored into this vector. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Void. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a506e8b57e5241949ee0d92f0bfd1b95f"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void EvictionPolicy::object_created </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>This method will be called whenever an object is first created in order to add it to the LRU cache. </p>
+<p>This is done so that the first time, the Plasma store calls begin_object_access, we can remove the object from the LRU cache.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The object ID of the object that was created. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Void. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="aef0a2efdc4ae24279237d70506bcdf91"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">bool EvictionPolicy::require_space </td>
+ <td>(</td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>size</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > * </td>
+ <td class="paramname"><em>objects_to_evict</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>This method will be called when the Plasma store needs more space, perhaps to create a new object. </p>
+<p>If the required amount of space cannot be freed up, then a fatal error will be thrown. When this method is called, the eviction policy will assume that the objects chosen to be evicted will in fact be evicted from the Plasma store by the caller.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">size</td><td>The size in bytes of the new object, including both data and metadata. </td></tr>
+ <tr><td class="paramname">objects_to_evict</td><td>The object IDs that were chosen for eviction will be stored into this vector. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>True if enough space can be freed and false otherwise. </dd></dl>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>/home/uwe/Development/arrow/cpp/src/plasma/<a class="el" href="eviction__policy_8h_source.html">eviction_policy.h</a></li>
+<li>/home/uwe/Development/arrow/cpp/src/plasma/<a class="el" href="eviction__policy_8cc.html">eviction_policy.cc</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.11
+</small></address>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/d37aab64/docs/cpp/class_l_r_u_cache-members.html
----------------------------------------------------------------------
diff --git a/docs/cpp/class_l_r_u_cache-members.html b/docs/cpp/class_l_r_u_cache-members.html
new file mode 100644
index 0000000..89daf12
--- /dev/null
+++ b/docs/cpp/class_l_r_u_cache-members.html
@@ -0,0 +1,107 @@
+<!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.11"/>
+<title>Apache Arrow (C++): Member List</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>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</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.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="annotated.html"><span>Class List</span></a></li>
+ <li><a href="classes.html"><span>Class Index</span></a></li>
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class Members</span></a></li>
+ </ul>
+ </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><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">LRUCache Member List</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="class_l_r_u_cache.html">LRUCache</a>, including all inherited members.</p>
+<table class="directory">
+ <tr class="even"><td class="entry"><a class="el" href="class_l_r_u_cache.html#a155872cef188938afe7bc341fb4e1d42">add</a>(const ObjectID &key, int64_t size)</td><td class="entry"><a class="el" href="class_l_r_u_cache.html">LRUCache</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_l_r_u_cache.html#a8b859627912c3f0b160ade605682e5d5">choose_objects_to_evict</a>(int64_t num_bytes_required, std::vector< ObjectID > *objects_to_evict)</td><td class="entry"><a class="el" href="class_l_r_u_cache.html">LRUCache</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_l_r_u_cache.html#a6f624ad11516bc5c8b56ab19250902bb">LRUCache</a>()</td><td class="entry"><a class="el" href="class_l_r_u_cache.html">LRUCache</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+ <tr><td class="entry"><a class="el" href="class_l_r_u_cache.html#a97d5110c7d94af31f361633c3dd66958">remove</a>(const ObjectID &key)</td><td class="entry"><a class="el" href="class_l_r_u_cache.html">LRUCache</a></td><td class="entry"></td></tr>
+</table></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.11
+</small></address>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/d37aab64/docs/cpp/class_l_r_u_cache.html
----------------------------------------------------------------------
diff --git a/docs/cpp/class_l_r_u_cache.html b/docs/cpp/class_l_r_u_cache.html
new file mode 100644
index 0000000..faf962c
--- /dev/null
+++ b/docs/cpp/class_l_r_u_cache.html
@@ -0,0 +1,214 @@
+<!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.11"/>
+<title>Apache Arrow (C++): LRUCache Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</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.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="annotated.html"><span>Class List</span></a></li>
+ <li><a href="classes.html"><span>Class Index</span></a></li>
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class Members</span></a></li>
+ </ul>
+ </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><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> |
+<a href="class_l_r_u_cache-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">LRUCache Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="eviction__policy_8h_source.html">eviction_policy.h</a>></code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a6f624ad11516bc5c8b56ab19250902bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r_u_cache.html#a6f624ad11516bc5c8b56ab19250902bb">LRUCache</a> ()</td></tr>
+<tr class="separator:a6f624ad11516bc5c8b56ab19250902bb"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a155872cef188938afe7bc341fb4e1d42"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r_u_cache.html#a155872cef188938afe7bc341fb4e1d42">add</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &key, int64_t size)</td></tr>
+<tr class="separator:a155872cef188938afe7bc341fb4e1d42"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a97d5110c7d94af31f361633c3dd66958"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r_u_cache.html#a97d5110c7d94af31f361633c3dd66958">remove</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &key)</td></tr>
+<tr class="separator:a97d5110c7d94af31f361633c3dd66958"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a8b859627912c3f0b160ade605682e5d5"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_l_r_u_cache.html#a8b859627912c3f0b160ade605682e5d5">choose_objects_to_evict</a> (int64_t num_bytes_required, std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > *objects_to_evict)</td></tr>
+<tr class="separator:a8b859627912c3f0b160ade605682e5d5"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<h2 class="groupheader">Constructor & Destructor Documentation</h2>
+<a class="anchor" id="a6f624ad11516bc5c8b56ab19250902bb"></a>
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+ <tr>
+ <td class="mlabels-left">
+ <table class="memname">
+ <tr>
+ <td class="memname">LRUCache::LRUCache </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+ </td>
+ <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span> </td>
+ </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a class="anchor" id="a155872cef188938afe7bc341fb4e1d42"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void LRUCache::add </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>key</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>size</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a class="anchor" id="a8b859627912c3f0b160ade605682e5d5"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int64_t LRUCache::choose_objects_to_evict </td>
+ <td>(</td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>num_bytes_required</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">std::vector< <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> > * </td>
+ <td class="paramname"><em>objects_to_evict</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<a class="anchor" id="a97d5110c7d94af31f361633c3dd66958"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">void LRUCache::remove </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>key</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>/home/uwe/Development/arrow/cpp/src/plasma/<a class="el" href="eviction__policy_8h_source.html">eviction_policy.h</a></li>
+<li>/home/uwe/Development/arrow/cpp/src/plasma/<a class="el" href="eviction__policy_8cc.html">eviction_policy.cc</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.11
+</small></address>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/d37aab64/docs/cpp/class_plasma_client-members.html
----------------------------------------------------------------------
diff --git a/docs/cpp/class_plasma_client-members.html b/docs/cpp/class_plasma_client-members.html
new file mode 100644
index 0000000..932e0d4
--- /dev/null
+++ b/docs/cpp/class_plasma_client-members.html
@@ -0,0 +1,118 @@
+<!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.11"/>
+<title>Apache Arrow (C++): Member List</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>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</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.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="annotated.html"><span>Class List</span></a></li>
+ <li><a href="classes.html"><span>Class Index</span></a></li>
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class Members</span></a></li>
+ </ul>
+ </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><!-- top -->
+<div class="header">
+ <div class="headertitle">
+<div class="title">PlasmaClient Member List</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p>This is the complete list of members for <a class="el" href="class_plasma_client.html">PlasmaClient</a>, including all inherited members.</p>
+<table class="directory">
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a25b02a3d53e54f76446f089e5fd71620">Connect</a>(const std::string &store_socket_name, const std::string &manager_socket_name, int release_delay)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#a0d0a053f6b14cc375ffb95d293548ea3">Contains</a>(const ObjectID &object_id, bool *has_object)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a19b619fc2286cf033b15c5e37d197a9d">Create</a>(const ObjectID &object_id, int64_t data_size, uint8_t *metadata, int64_t metadata_size, uint8_t **data)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#a9608cc699bf072320371e1f748042d07">Delete</a>(const ObjectID &object_id)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#af5b2b15544614d31814a0f4c093fb363">Disconnect</a>()</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#a9e47e6e34bc4fb4168e5c4cf11aaf4fd">Evict</a>(int64_t num_bytes, int64_t &num_bytes_evicted)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a9c64805c010c38370fb2ac375c205e54">Fetch</a>(int num_object_ids, const ObjectID *object_ids)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#a9284d4b090fbf2ead11fd17d9f621e55">Get</a>(const ObjectID *object_ids, int64_t num_objects, int64_t timeout_ms, ObjectBuffer *object_buffers)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a2cd5e038d9b823806c44e29f29d8a6c2">get_manager_fd</a>()</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#a5bd0e1536808ed17e215b9a04a2d5ca2">Info</a>(const ObjectID &object_id, int *object_status)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a44b0238c36a0e7e8b62e9eb3c99bc86a">Release</a>(const ObjectID &object_id)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#abc7b445521ccd3b1fbb352b1e2c3777d">Seal</a>(const ObjectID &object_id)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a73c4a6d8c9460bac280b7b42dacd79b8">Subscribe</a>(int *fd)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr><td class="entry"><a class="el" href="class_plasma_client.html#a688f6dbc08badb5321c5a36f6150aa3e">Transfer</a>(const char *addr, int port, const ObjectID &object_id)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+ <tr class="even"><td class="entry"><a class="el" href="class_plasma_client.html#a388d6f1ba8997df579c15e0f7b7df87e">Wait</a>(int64_t num_object_requests, ObjectRequest *object_requests, int num_ready_objects, int64_t timeout_ms, int *num_objects_ready)</td><td class="entry"><a class="el" href="class_plasma_client.html">PlasmaClient</a></td><td class="entry"></td></tr>
+</table></div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.11
+</small></address>
+</body>
+</html>
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/d37aab64/docs/cpp/class_plasma_client.html
----------------------------------------------------------------------
diff --git a/docs/cpp/class_plasma_client.html b/docs/cpp/class_plasma_client.html
new file mode 100644
index 0000000..750bb44
--- /dev/null
+++ b/docs/cpp/class_plasma_client.html
@@ -0,0 +1,723 @@
+<!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.11"/>
+<title>Apache Arrow (C++): PlasmaClient Class Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</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.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="annotated.html"><span>Class List</span></a></li>
+ <li><a href="classes.html"><span>Class Index</span></a></li>
+ <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
+ <li><a href="functions.html"><span>Class Members</span></a></li>
+ </ul>
+ </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><!-- top -->
+<div class="header">
+ <div class="summary">
+<a href="#pub-methods">Public Member Functions</a> |
+<a href="class_plasma_client-members.html">List of all members</a> </div>
+ <div class="headertitle">
+<div class="title">PlasmaClient Class Reference</div> </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include <<a class="el" href="client_8h_source.html">client.h</a>></code></p>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a25b02a3d53e54f76446f089e5fd71620"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a25b02a3d53e54f76446f089e5fd71620">Connect</a> (const std::string &store_socket_name, const std::string &manager_socket_name, int release_delay)</td></tr>
+<tr class="memdesc:a25b02a3d53e54f76446f089e5fd71620"><td class="mdescLeft"> </td><td class="mdescRight">Connect to the local plasma store and plasma manager. <a href="#a25b02a3d53e54f76446f089e5fd71620">More...</a><br /></td></tr>
+<tr class="separator:a25b02a3d53e54f76446f089e5fd71620"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a19b619fc2286cf033b15c5e37d197a9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a19b619fc2286cf033b15c5e37d197a9d">Create</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id, int64_t data_size, uint8_t *metadata, int64_t metadata_size, uint8_t **data)</td></tr>
+<tr class="memdesc:a19b619fc2286cf033b15c5e37d197a9d"><td class="mdescLeft"> </td><td class="mdescRight">Create an object in the Plasma Store. <a href="#a19b619fc2286cf033b15c5e37d197a9d">More...</a><br /></td></tr>
+<tr class="separator:a19b619fc2286cf033b15c5e37d197a9d"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a9284d4b090fbf2ead11fd17d9f621e55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a9284d4b090fbf2ead11fd17d9f621e55">Get</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> *object_ids, int64_t num_objects, int64_t timeout_ms, <a class="el" href="struct_object_buffer.html">ObjectBuffer</a> *object_buffers)</td></tr>
+<tr class="memdesc:a9284d4b090fbf2ead11fd17d9f621e55"><td class="mdescLeft"> </td><td class="mdescRight">Get some objects from the Plasma Store. <a href="#a9284d4b090fbf2ead11fd17d9f621e55">More...</a><br /></td></tr>
+<tr class="separator:a9284d4b090fbf2ead11fd17d9f621e55"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a44b0238c36a0e7e8b62e9eb3c99bc86a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a44b0238c36a0e7e8b62e9eb3c99bc86a">Release</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id)</td></tr>
+<tr class="memdesc:a44b0238c36a0e7e8b62e9eb3c99bc86a"><td class="mdescLeft"> </td><td class="mdescRight">Tell Plasma that the client no longer needs the object. <a href="#a44b0238c36a0e7e8b62e9eb3c99bc86a">More...</a><br /></td></tr>
+<tr class="separator:a44b0238c36a0e7e8b62e9eb3c99bc86a"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a0d0a053f6b14cc375ffb95d293548ea3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a0d0a053f6b14cc375ffb95d293548ea3">Contains</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id, bool *has_object)</td></tr>
+<tr class="memdesc:a0d0a053f6b14cc375ffb95d293548ea3"><td class="mdescLeft"> </td><td class="mdescRight">Check if the object store contains a particular object and the object has been sealed. <a href="#a0d0a053f6b14cc375ffb95d293548ea3">More...</a><br /></td></tr>
+<tr class="separator:a0d0a053f6b14cc375ffb95d293548ea3"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:abc7b445521ccd3b1fbb352b1e2c3777d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#abc7b445521ccd3b1fbb352b1e2c3777d">Seal</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id)</td></tr>
+<tr class="memdesc:abc7b445521ccd3b1fbb352b1e2c3777d"><td class="mdescLeft"> </td><td class="mdescRight">Seal an object in the object store. <a href="#abc7b445521ccd3b1fbb352b1e2c3777d">More...</a><br /></td></tr>
+<tr class="separator:abc7b445521ccd3b1fbb352b1e2c3777d"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a9608cc699bf072320371e1f748042d07"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a9608cc699bf072320371e1f748042d07">Delete</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id)</td></tr>
+<tr class="memdesc:a9608cc699bf072320371e1f748042d07"><td class="mdescLeft"> </td><td class="mdescRight">Delete an object from the object store. <a href="#a9608cc699bf072320371e1f748042d07">More...</a><br /></td></tr>
+<tr class="separator:a9608cc699bf072320371e1f748042d07"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a9e47e6e34bc4fb4168e5c4cf11aaf4fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a9e47e6e34bc4fb4168e5c4cf11aaf4fd">Evict</a> (int64_t num_bytes, int64_t &num_bytes_evicted)</td></tr>
+<tr class="memdesc:a9e47e6e34bc4fb4168e5c4cf11aaf4fd"><td class="mdescLeft"> </td><td class="mdescRight">Delete objects until we have freed up num_bytes bytes or there are no more released objects that can be deleted. <a href="#a9e47e6e34bc4fb4168e5c4cf11aaf4fd">More...</a><br /></td></tr>
+<tr class="separator:a9e47e6e34bc4fb4168e5c4cf11aaf4fd"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a73c4a6d8c9460bac280b7b42dacd79b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a73c4a6d8c9460bac280b7b42dacd79b8">Subscribe</a> (int *fd)</td></tr>
+<tr class="memdesc:a73c4a6d8c9460bac280b7b42dacd79b8"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to notifications when objects are sealed in the object store. <a href="#a73c4a6d8c9460bac280b7b42dacd79b8">More...</a><br /></td></tr>
+<tr class="separator:a73c4a6d8c9460bac280b7b42dacd79b8"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:af5b2b15544614d31814a0f4c093fb363"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#af5b2b15544614d31814a0f4c093fb363">Disconnect</a> ()</td></tr>
+<tr class="memdesc:af5b2b15544614d31814a0f4c093fb363"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the local plasma instance, including the local store and manager. <a href="#af5b2b15544614d31814a0f4c093fb363">More...</a><br /></td></tr>
+<tr class="separator:af5b2b15544614d31814a0f4c093fb363"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a9c64805c010c38370fb2ac375c205e54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a9c64805c010c38370fb2ac375c205e54">Fetch</a> (int num_object_ids, const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> *object_ids)</td></tr>
+<tr class="memdesc:a9c64805c010c38370fb2ac375c205e54"><td class="mdescLeft"> </td><td class="mdescRight">Attempt to initiate the transfer of some objects from remote Plasma Stores. <a href="#a9c64805c010c38370fb2ac375c205e54">More...</a><br /></td></tr>
+<tr class="separator:a9c64805c010c38370fb2ac375c205e54"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a388d6f1ba8997df579c15e0f7b7df87e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a388d6f1ba8997df579c15e0f7b7df87e">Wait</a> (int64_t num_object_requests, <a class="el" href="struct_object_request.html">ObjectRequest</a> *object_requests, int num_ready_objects, int64_t timeout_ms, int *num_objects_ready)</td></tr>
+<tr class="memdesc:a388d6f1ba8997df579c15e0f7b7df87e"><td class="mdescLeft"> </td><td class="mdescRight">Wait for (1) a specified number of objects to be available (sealed) in the local Plasma Store or in a remote Plasma Store, or (2) for a timeout to expire. <a href="#a388d6f1ba8997df579c15e0f7b7df87e">More...</a><br /></td></tr>
+<tr class="separator:a388d6f1ba8997df579c15e0f7b7df87e"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a688f6dbc08badb5321c5a36f6150aa3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a688f6dbc08badb5321c5a36f6150aa3e">Transfer</a> (const char *addr, int port, const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id)</td></tr>
+<tr class="memdesc:a688f6dbc08badb5321c5a36f6150aa3e"><td class="mdescLeft"> </td><td class="mdescRight">Transfer local object to a different plasma manager. <a href="#a688f6dbc08badb5321c5a36f6150aa3e">More...</a><br /></td></tr>
+<tr class="separator:a688f6dbc08badb5321c5a36f6150aa3e"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a5bd0e1536808ed17e215b9a04a2d5ca2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarrow_1_1_status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a5bd0e1536808ed17e215b9a04a2d5ca2">Info</a> (const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> &object_id, int *<a class="el" href="plasma_8h.html#a821953e7375ebfd0a5d7d0f9960cfe82">object_status</a>)</td></tr>
+<tr class="memdesc:a5bd0e1536808ed17e215b9a04a2d5ca2"><td class="mdescLeft"> </td><td class="mdescRight">Return the status of a given object. <a href="#a5bd0e1536808ed17e215b9a04a2d5ca2">More...</a><br /></td></tr>
+<tr class="separator:a5bd0e1536808ed17e215b9a04a2d5ca2"><td class="memSeparator" colspan="2"> </td></tr>
+<tr class="memitem:a2cd5e038d9b823806c44e29f29d8a6c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_plasma_client.html#a2cd5e038d9b823806c44e29f29d8a6c2">get_manager_fd</a> ()</td></tr>
+<tr class="memdesc:a2cd5e038d9b823806c44e29f29d8a6c2"><td class="mdescLeft"> </td><td class="mdescRight">Get the file descriptor for the socket connection to the plasma manager. <a href="#a2cd5e038d9b823806c44e29f29d8a6c2">More...</a><br /></td></tr>
+<tr class="separator:a2cd5e038d9b823806c44e29f29d8a6c2"><td class="memSeparator" colspan="2"> </td></tr>
+</table>
+<h2 class="groupheader">Member Function Documentation</h2>
+<a class="anchor" id="a25b02a3d53e54f76446f089e5fd71620"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Connect </td>
+ <td>(</td>
+ <td class="paramtype">const std::string & </td>
+ <td class="paramname"><em>store_socket_name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const std::string & </td>
+ <td class="paramname"><em>manager_socket_name</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int </td>
+ <td class="paramname"><em>release_delay</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Connect to the local plasma store and plasma manager. </p>
+<p>Return the resulting connection.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">store_socket_name</td><td>The name of the UNIX domain socket to use to connect to the Plasma store. </td></tr>
+ <tr><td class="paramname">manager_socket_name</td><td>The name of the UNIX domain socket to use to connect to the local Plasma manager. If this is "", then this function will not connect to a manager. </td></tr>
+ <tr><td class="paramname">release_delay</td><td>Number of released objects that are kept around and not evicted to avoid too many munmaps. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a0d0a053f6b14cc375ffb95d293548ea3"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Contains </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">bool * </td>
+ <td class="paramname"><em>has_object</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Check if the object store contains a particular object and the object has been sealed. </p>
+<p>The result will be stored in has_object.</p>
+<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>: We may want to indicate if the object has been created but not sealed.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID of the object whose presence we are checking. </td></tr>
+ <tr><td class="paramname">has_object</td><td>The function will write true at this address if the object is present and false if it is not present. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a19b619fc2286cf033b15c5e37d197a9d"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Create </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>data_size</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t * </td>
+ <td class="paramname"><em>metadata</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>metadata_size</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">uint8_t ** </td>
+ <td class="paramname"><em>data</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Create an object in the Plasma Store. </p>
+<p>Any metadata for this object must be be passed in when the object is created.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID to use for the newly created object. </td></tr>
+ <tr><td class="paramname">data_size</td><td>The size in bytes of the space to be allocated for this object's data (this does not include space used for metadata). </td></tr>
+ <tr><td class="paramname">metadata</td><td>The object's metadata. If there is no metadata, this pointer should be NULL. </td></tr>
+ <tr><td class="paramname">metadata_size</td><td>The size in bytes of the metadata. If there is no metadata, this should be 0. </td></tr>
+ <tr><td class="paramname">data</td><td>The address of the newly created object will be written here. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a9608cc699bf072320371e1f748042d07"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Delete </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Delete an object from the object store. </p>
+<p>This currently assumes that the object is present and has been sealed.</p>
+<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>We may want to allow the deletion of objects that are not present or haven't been sealed.</dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID of the object to delete. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="af5b2b15544614d31814a0f4c093fb363"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Disconnect </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Disconnect from the local plasma instance, including the local store and manager. </p>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a9e47e6e34bc4fb4168e5c4cf11aaf4fd"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Evict </td>
+ <td>(</td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>num_bytes</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t & </td>
+ <td class="paramname"><em>num_bytes_evicted</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Delete objects until we have freed up num_bytes bytes or there are no more released objects that can be deleted. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">num_bytes</td><td>The number of bytes to try to free up. </td></tr>
+ <tr><td class="paramname">num_bytes_evicted</td><td>Out parameter for total number of bytes of space retrieved. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a9c64805c010c38370fb2ac375c205e54"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Fetch </td>
+ <td>(</td>
+ <td class="paramtype">int </td>
+ <td class="paramname"><em>num_object_ids</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> * </td>
+ <td class="paramname"><em>object_ids</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Attempt to initiate the transfer of some objects from remote Plasma Stores. </p>
+<p>This method does not guarantee that the fetched objects will arrive locally.</p>
+<p>For an object that is available in the local Plasma Store, this method will not do anything. For an object that is not available locally, it will check if the object are already being fetched. If so, it will not do anything. If not, it will query the object table for a list of Plasma Managers that have the object. The object table will return a non-empty list, and this Plasma Manager will attempt to initiate transfers from one of those Plasma Managers.</p>
+<p>This function is non-blocking.</p>
+<p>This method is idempotent in the sense that it is ok to call it multiple times.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">num_object_ids</td><td>The number of object IDs fetch is being called on. </td></tr>
+ <tr><td class="paramname">object_ids</td><td>The IDs of the objects that fetch is being called on. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a9284d4b090fbf2ead11fd17d9f621e55"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Get </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> * </td>
+ <td class="paramname"><em>object_ids</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>num_objects</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>timeout_ms</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="struct_object_buffer.html">ObjectBuffer</a> * </td>
+ <td class="paramname"><em>object_buffers</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Get some objects from the Plasma Store. </p>
+<p>This function will block until the objects have all been created and sealed in the Plasma Store or the timeout expires. The caller is responsible for releasing any retrieved objects, but the caller should not release objects that were not retrieved.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_ids</td><td>The IDs of the objects to get. </td></tr>
+ <tr><td class="paramname">num_object_ids</td><td>The number of object IDs to get. </td></tr>
+ <tr><td class="paramname">timeout_ms</td><td>The amount of time in milliseconds to wait before this request times out. If this value is -1, then no timeout is set. </td></tr>
+ <tr><td class="paramname">object_buffers</td><td>An array where the results will be stored. If the data size field is -1, then the object was not retrieved. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a2cd5e038d9b823806c44e29f29d8a6c2"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname">int PlasmaClient::get_manager_fd </td>
+ <td>(</td>
+ <td class="paramname"></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Get the file descriptor for the socket connection to the plasma manager. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">conn</td><td>The plasma connection. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The file descriptor for the manager connection. If there is no connection to the manager, this is -1. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a5bd0e1536808ed17e215b9a04a2d5ca2"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Info </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int * </td>
+ <td class="paramname"><em>object_status</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Return the status of a given object. </p>
+<p>This method may query the object table.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">conn</td><td>The object containing the connection state. </td></tr>
+ <tr><td class="paramname">object_id</td><td>The ID of the object whose status we query. </td></tr>
+ <tr><td class="paramname">object_status</td><td>Out parameter for object status. Can take the following values.<ul>
+<li>PLASMA_CLIENT_LOCAL, if object is stored in the local Plasma Store. has been already scheduled by the Plasma Manager.</li>
+<li>PLASMA_CLIENT_TRANSFER, if the object is either currently being transferred or just scheduled.</li>
+<li>PLASMA_CLIENT_REMOTE, if the object is stored at a remote Plasma Store.</li>
+<li>PLASMA_CLIENT_DOES_NOT_EXIST, if the object doesn’t exist in the system. </li>
+</ul>
+</td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a44b0238c36a0e7e8b62e9eb3c99bc86a"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Release </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Tell Plasma that the client no longer needs the object. </p>
+<p>This should be called after Get when the client is done with the object. After this call, the address returned by Get is no longer valid. This should be called once for each call to Get (with the same object ID).</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID of the object that is no longer needed. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="abc7b445521ccd3b1fbb352b1e2c3777d"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Seal </td>
+ <td>(</td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Seal an object in the object store. </p>
+<p>The object will be immutable after this call.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">object_id</td><td>The ID of the object to seal. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+<p>Send the seal request to Plasma. </p>
+
+</div>
+</div>
+<a class="anchor" id="a73c4a6d8c9460bac280b7b42dacd79b8"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Subscribe </td>
+ <td>(</td>
+ <td class="paramtype">int * </td>
+ <td class="paramname"><em>fd</em></td><td>)</td>
+ <td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Subscribe to notifications when objects are sealed in the object store. </p>
+<p>Whenever an object is sealed, a message will be written to the client socket that is returned by this method.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">fd</td><td>Out parameter for the file descriptor the client should use to read notifications from the object store about sealed objects. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a688f6dbc08badb5321c5a36f6150aa3e"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Transfer </td>
+ <td>(</td>
+ <td class="paramtype">const char * </td>
+ <td class="paramname"><em>addr</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int </td>
+ <td class="paramname"><em>port</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">const <a class="el" href="plasma_2common_8h.html#ad4839eacbe38df264313bd61fd66ddf1">ObjectID</a> & </td>
+ <td class="paramname"><em>object_id</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Transfer local object to a different plasma manager. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">conn</td><td>The object containing the connection state. </td></tr>
+ <tr><td class="paramname">addr</td><td>IP address of the plasma manager we are transfering to. </td></tr>
+ <tr><td class="paramname">port</td><td>Port of the plasma manager we are transfering to. ObjectID of the object we are transfering. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<a class="anchor" id="a388d6f1ba8997df579c15e0f7b7df87e"></a>
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
+ <tr>
+ <td class="memname"><a class="el" href="classarrow_1_1_status.html">Status</a> PlasmaClient::Wait </td>
+ <td>(</td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>num_object_requests</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype"><a class="el" href="struct_object_request.html">ObjectRequest</a> * </td>
+ <td class="paramname"><em>object_requests</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int </td>
+ <td class="paramname"><em>num_ready_objects</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int64_t </td>
+ <td class="paramname"><em>timeout_ms</em>, </td>
+ </tr>
+ <tr>
+ <td class="paramkey"></td>
+ <td></td>
+ <td class="paramtype">int * </td>
+ <td class="paramname"><em>num_objects_ready</em> </td>
+ </tr>
+ <tr>
+ <td></td>
+ <td>)</td>
+ <td></td><td></td>
+ </tr>
+ </table>
+</div><div class="memdoc">
+
+<p>Wait for (1) a specified number of objects to be available (sealed) in the local Plasma Store or in a remote Plasma Store, or (2) for a timeout to expire. </p>
+<p>This is a blocking call.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">num_object_requests</td><td>Size of the object_requests array. </td></tr>
+ <tr><td class="paramname">object_requests</td><td>Object event array. Each element contains a request for a particular object_id. The type of request is specified in the "type" field.<ul>
+<li>A PLASMA_QUERY_LOCAL request is satisfied when object_id becomes available in the local Plasma Store. In this case, this function sets the "status" field to ObjectStatus_Local. Note, if the status is not ObjectStatus_Local, it will be ObjectStatus_Nonexistent, but it may exist elsewhere in the system.</li>
+<li>A PLASMA_QUERY_ANYWHERE request is satisfied when object_id becomes available either at the local Plasma Store or on a remote Plasma Store. In this case, the functions sets the "status" field to ObjectStatus_Local or ObjectStatus_Remote. </li>
+</ul>
+</td></tr>
+ <tr><td class="paramname">num_ready_objects</td><td>The number of requests in object_requests array that must be satisfied before the function returns, unless it timeouts. The num_ready_objects should be no larger than num_object_requests. </td></tr>
+ <tr><td class="paramname">timeout_ms</td><td>Timeout value in milliseconds. If this timeout expires before min_num_ready_objects of requests are satisfied, the function returns. </td></tr>
+ <tr><td class="paramname">num_objects_ready</td><td>Out parameter for number of satisfied requests in the object_requests list. If the returned number is less than min_num_ready_objects this means that timeout expired. </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The return status. </dd></dl>
+
+</div>
+</div>
+<hr/>The documentation for this class was generated from the following files:<ul>
+<li>/home/uwe/Development/arrow/cpp/src/plasma/<a class="el" href="client_8h_source.html">client.h</a></li>
+<li>/home/uwe/Development/arrow/cpp/src/plasma/<a class="el" href="client_8cc.html">client.cc</a></li>
+</ul>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by  <a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.11
+</small></address>
+</body>
+</html>