blob: 4b802b5918278b882533739bb14844ac08c8d1d7 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kudu C++ client API: kudu::client::KuduStatusFunctionCallback&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kudu C++ client API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>kudu</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html">KuduStatusFunctionCallback</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classkudu_1_1client_1_1KuduStatusFunctionCallback-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">kudu::client::KuduStatusFunctionCallback&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The status callback that invokes a function by pointer with a single argument.
<a href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="callbacks_8h_source.html">callbacks.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for kudu::client::KuduStatusFunctionCallback&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classkudu_1_1client_1_1KuduStatusFunctionCallback__inherit__graph.png" border="0" usemap="#kudu_1_1client_1_1KuduStatusFunctionCallback_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="kudu_1_1client_1_1KuduStatusFunctionCallback_3_01T_01_4_inherit__map" id="kudu_1_1client_1_1KuduStatusFunctionCallback_3_01T_01_4_inherit__map">
<area shape="rect" id="node2" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks. " alt="" coords="5,5,171,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for kudu::client::KuduStatusFunctionCallback&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classkudu_1_1client_1_1KuduStatusFunctionCallback__coll__graph.png" border="0" usemap="#kudu_1_1client_1_1KuduStatusFunctionCallback_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="kudu_1_1client_1_1KuduStatusFunctionCallback_3_01T_01_4_coll__map" id="kudu_1_1client_1_1KuduStatusFunctionCallback_3_01T_01_4_coll__map">
<area shape="rect" id="node2" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks. " alt="" coords="5,5,171,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a20c231ae32873ea7f462b8f3ea05d910"><td class="memItemLeft" align="right" valign="top"><a id="a20c231ae32873ea7f462b8f3ea05d910"></a>
typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#a20c231ae32873ea7f462b8f3ea05d910">FunctionType</a>) (T arg, const <a class="el" href="classkudu_1_1Status.html">Status</a> &amp;s)</td></tr>
<tr class="memdesc:a20c231ae32873ea7f462b8f3ea05d910"><td class="mdescLeft">&#160;</td><td class="mdescRight">A handy typedef for the function with appropriate signature. <br /></td></tr>
<tr class="separator:a20c231ae32873ea7f462b8f3ea05d910"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aca289bbf6ad9720bd74a90550f6c9b3b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#aca289bbf6ad9720bd74a90550f6c9b3b">KuduStatusFunctionCallback</a> (<a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#a20c231ae32873ea7f462b8f3ea05d910">FunctionType</a> function, T arg)</td></tr>
<tr class="separator:aca289bbf6ad9720bd74a90550f6c9b3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4c3e7fbd4fed52bcba220f95a27f70a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#af4c3e7fbd4fed52bcba220f95a27f70a">Run</a> (const <a class="el" href="classkudu_1_1Status.html">Status</a> &amp;s) OVERRIDE</td></tr>
<tr class="separator:af4c3e7fbd4fed52bcba220f95a27f70a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class kudu::client::KuduStatusFunctionCallback&lt; T &gt;</h3>
<p>The status callback that invokes a function by pointer with a single argument. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aca289bbf6ad9720bd74a90550f6c9b3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca289bbf6ad9720bd74a90550f6c9b3b">&#9670;&nbsp;</a></span>KuduStatusFunctionCallback()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html">kudu::client::KuduStatusFunctionCallback</a>&lt; T &gt;::<a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html">KuduStatusFunctionCallback</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#a20c231ae32873ea7f462b8f3ea05d910">FunctionType</a>&#160;</td>
<td class="paramname"><em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Build an instance of <a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html" title="The status callback that invokes a function by pointer with a single argument. ">KuduStatusFunctionCallback</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">function</td><td>A pointer to the status report function to invoke with the <code>arg</code> argument. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">arg</td><td>An argument for the function invocation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af4c3e7fbd4fed52bcba220f95a27f70a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4c3e7fbd4fed52bcba220f95a27f70a">&#9670;&nbsp;</a></span>Run()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html">kudu::client::KuduStatusFunctionCallback</a>&lt; T &gt;::Run </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classkudu_1_1Status.html">Status</a> &amp;&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<p>Notify/report on the status.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The status to report. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classkudu_1_1client_1_1KuduStatusCallback.html#a2333beedb1d0c08a8c127b4552fbeb07">kudu::client::KuduStatusCallback</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/kudu/client/<a class="el" href="callbacks_8h_source.html">callbacks.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.11.0 on Wed Oct 30 2019 18:37:39 by Doxygen 1.8.13</small>
<br>
<small>Copyright © 2019 The Apache Software Foundation.</small>
</address>
</body>
</html>