blob: b276bdbcba330516328450ccfd693c59cfe8e62f [file] [log] [blame]
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>Kudu C++ client API: include/kudu/client/callbacks.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.1 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.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)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
</ul>
</div>
<h1>include/kudu/client/callbacks.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Licensed to the Apache Software Foundation (ASF) under one</span>
<a name="l00002"></a>00002 <span class="comment">// or more contributor license agreements. See the NOTICE file</span>
<a name="l00003"></a>00003 <span class="comment">// distributed with this work for additional information</span>
<a name="l00004"></a>00004 <span class="comment">// regarding copyright ownership. The ASF licenses this file</span>
<a name="l00005"></a>00005 <span class="comment">// to you under the Apache License, Version 2.0 (the</span>
<a name="l00006"></a>00006 <span class="comment">// &quot;License&quot;); you may not use this file except in compliance</span>
<a name="l00007"></a>00007 <span class="comment">// with the License. You may obtain a copy of the License at</span>
<a name="l00008"></a>00008 <span class="comment">//</span>
<a name="l00009"></a>00009 <span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Unless required by applicable law or agreed to in writing,</span>
<a name="l00012"></a>00012 <span class="comment">// software distributed under the License is distributed on an</span>
<a name="l00013"></a>00013 <span class="comment">// &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<a name="l00014"></a>00014 <span class="comment">// KIND, either express or implied. See the License for the</span>
<a name="l00015"></a>00015 <span class="comment">// specific language governing permissions and limitations</span>
<a name="l00016"></a>00016 <span class="comment">// under the License.</span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef KUDU_CLIENT_CALLBACKS_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define KUDU_CLIENT_CALLBACKS_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#ifdef KUDU_HEADERS_NO_STUBS</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#include &quot;kudu/gutil/macros.h&quot;</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include &quot;kudu/gutil/port.h&quot;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#else</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#include &quot;kudu/client/stubs.h&quot;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#endif</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#include &quot;kudu/util/kudu_export.h&quot;</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>kudu {
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">class </span>Status;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>client {
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00036"></a>00036 <span class="keyword">enum</span> KuduLogSeverity {
<a name="l00037"></a>00037 SEVERITY_INFO,
<a name="l00038"></a>00038 SEVERITY_WARNING,
<a name="l00039"></a>00039 SEVERITY_ERROR,
<a name="l00040"></a>00040 SEVERITY_FATAL
<a name="l00041"></a>00041 };
<a name="l00042"></a>00042
<a name="l00044"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html">00044</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks.">KuduLoggingCallback</a> {
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046 <a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks.">KuduLoggingCallback</a>() {
<a name="l00047"></a>00047 }
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">virtual</span> ~<a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks.">KuduLoggingCallback</a>() {
<a name="l00050"></a>00050 }
<a name="l00051"></a>00051
<a name="l00068"></a>00068 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run(KuduLogSeverity severity,
<a name="l00069"></a>00069 <span class="keyword">const</span> <span class="keywordtype">char</span>* filename,
<a name="l00070"></a>00070 <span class="keywordtype">int</span> line_number,
<a name="l00071"></a>00071 <span class="keyword">const</span> struct ::tm* time,
<a name="l00072"></a>00072 <span class="keyword">const</span> <span class="keywordtype">char</span>* message,
<a name="l00073"></a>00073 <span class="keywordtype">size_t</span> message_len) = 0;
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">private</span>:
<a name="l00076"></a>00076 DISALLOW_COPY_AND_ASSIGN(<a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks.">KuduLoggingCallback</a>);
<a name="l00077"></a>00077 };
<a name="l00078"></a>00078
<a name="l00080"></a>00080 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00081"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingMemberCallback.html">00081</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduLoggingMemberCallback.html" title="The logging callback that invokes a member function of an object.">KuduLoggingMemberCallback</a> : <span class="keyword">public</span> <a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks.">KuduLoggingCallback</a> {
<a name="l00082"></a>00082 <span class="keyword">public</span>:
<a name="l00084"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingMemberCallback.html#a5b9d3ed4c111163156a4836152c05afd">00084</a> <span class="keyword">typedef</span> void (T::*MemberType)(
<a name="l00085"></a>00085 KuduLogSeverity severity,
<a name="l00086"></a>00086 <span class="keyword">const</span> <span class="keywordtype">char</span>* filename,
<a name="l00087"></a>00087 <span class="keywordtype">int</span> line_number,
<a name="l00088"></a>00088 <span class="keyword">const</span> struct ::tm* time,
<a name="l00089"></a>00089 <span class="keyword">const</span> <span class="keywordtype">char</span>* message,
<a name="l00090"></a>00090 <span class="keywordtype">size_t</span> message_len);
<a name="l00091"></a>00091
<a name="l00098"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingMemberCallback.html#aeda4119b1288db0d055c9800e3485fd8">00098</a> <a class="code" href="classkudu_1_1client_1_1KuduLoggingMemberCallback.html" title="The logging callback that invokes a member function of an object.">KuduLoggingMemberCallback</a>(T* <span class="keywordtype">object</span>, MemberType member)
<a name="l00099"></a>00099 : object_(object),
<a name="l00100"></a>00100 member_(member) {
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102
<a name="l00104"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingMemberCallback.html#a3d75e43bb4af846af66735fabe642a88">00104</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run(KuduLogSeverity severity,
<a name="l00105"></a>00105 <span class="keyword">const</span> <span class="keywordtype">char</span>* filename,
<a name="l00106"></a>00106 <span class="keywordtype">int</span> line_number,
<a name="l00107"></a>00107 <span class="keyword">const</span> struct ::tm* time,
<a name="l00108"></a>00108 <span class="keyword">const</span> <span class="keywordtype">char</span>* message,
<a name="l00109"></a>00109 <span class="keywordtype">size_t</span> message_len) OVERRIDE {
<a name="l00110"></a>00110 (object_-&gt;*member_)(severity, filename, line_number, time,
<a name="l00111"></a>00111 message, message_len);
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keyword">private</span>:
<a name="l00115"></a>00115 T* object_;
<a name="l00116"></a>00116 MemberType member_;
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00121"></a>00121 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00122"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html">00122</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html" title="The logging callback that invokes a function by pointer with a single argument.">KuduLoggingFunctionCallback</a> : <span class="keyword">public</span> <a class="code" href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks.">KuduLoggingCallback</a> {
<a name="l00123"></a>00123 <span class="keyword">public</span>:
<a name="l00125"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#a98d1aaa700982691ec6ceedd87498f4b">00125</a> <span class="keyword">typedef</span> void (*FunctionType)(T arg,
<a name="l00126"></a>00126 KuduLogSeverity severity,
<a name="l00127"></a>00127 <span class="keyword">const</span> <span class="keywordtype">char</span>* filename,
<a name="l00128"></a>00128 <span class="keywordtype">int</span> line_number,
<a name="l00129"></a>00129 <span class="keyword">const</span> struct ::tm* time,
<a name="l00130"></a>00130 <span class="keyword">const</span> <span class="keywordtype">char</span>* message,
<a name="l00131"></a>00131 <span class="keywordtype">size_t</span> message_len);
<a name="l00132"></a>00132
<a name="l00139"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#a4263c504b21e0e5827f47a902e908a2c">00139</a> <a class="code" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html" title="The logging callback that invokes a function by pointer with a single argument.">KuduLoggingFunctionCallback</a>(FunctionType function, T arg)
<a name="l00140"></a>00140 : function_(function),
<a name="l00141"></a>00141 arg_(arg) {
<a name="l00142"></a>00142 }
<a name="l00143"></a>00143
<a name="l00145"></a><a class="code" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#ab5119cbc60675f3ca77e08c1e87ec215">00145</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run(KuduLogSeverity severity,
<a name="l00146"></a>00146 <span class="keyword">const</span> <span class="keywordtype">char</span>* filename,
<a name="l00147"></a>00147 <span class="keywordtype">int</span> line_number,
<a name="l00148"></a>00148 <span class="keyword">const</span> struct ::tm* time,
<a name="l00149"></a>00149 <span class="keyword">const</span> <span class="keywordtype">char</span>* message,
<a name="l00150"></a>00150 <span class="keywordtype">size_t</span> message_len) OVERRIDE {
<a name="l00151"></a>00151 function_(arg_, severity, filename, line_number, time,
<a name="l00152"></a>00152 message, message_len);
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keyword">private</span>:
<a name="l00156"></a>00156 FunctionType function_;
<a name="l00157"></a>00157 T arg_;
<a name="l00158"></a>00158 };
<a name="l00159"></a>00159
<a name="l00161"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html">00161</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks.">KuduStatusCallback</a> {
<a name="l00162"></a>00162 <span class="keyword">public</span>:
<a name="l00163"></a>00163 <a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks.">KuduStatusCallback</a>() {
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="keyword">virtual</span> ~<a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks.">KuduStatusCallback</a>() {
<a name="l00167"></a>00167 }
<a name="l00168"></a>00168
<a name="l00173"></a>00173 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Run(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&amp;#39;s outcome.">Status</a>&amp; s) = 0;
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keyword">private</span>:
<a name="l00176"></a>00176 DISALLOW_COPY_AND_ASSIGN(<a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks.">KuduStatusCallback</a>);
<a name="l00177"></a>00177 };
<a name="l00178"></a>00178
<a name="l00180"></a>00180 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00181"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html">00181</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html" title="The status callback that invokes a member function of an object.">KuduStatusMemberCallback</a> : <span class="keyword">public</span> <a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks.">KuduStatusCallback</a> {
<a name="l00182"></a>00182 <span class="keyword">public</span>:
<a name="l00184"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html#a260174e9be807a51fb050c58b047fbdf">00184</a> <span class="keyword">typedef</span> void (T::*MemberType)(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&amp;#39;s outcome.">Status</a>&amp; s);
<a name="l00185"></a>00185
<a name="l00192"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html#acdb02b9798adf2c80b39cfb024f199aa">00192</a> <a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html" title="The status callback that invokes a member function of an object.">KuduStatusMemberCallback</a>(T* <span class="keywordtype">object</span>, MemberType member)
<a name="l00193"></a>00193 : object_(object),
<a name="l00194"></a>00194 member_(member) {
<a name="l00195"></a>00195 }
<a name="l00196"></a>00196
<a name="l00198"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html#a94bde1bdcb3cde6f78b11d822be19232">00198</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classkudu_1_1client_1_1KuduStatusMemberCallback.html#a94bde1bdcb3cde6f78b11d822be19232">Run</a>(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&amp;#39;s outcome.">Status</a>&amp; s) OVERRIDE {
<a name="l00199"></a>00199 (object_-&gt;*member_)(s);
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="keyword">private</span>:
<a name="l00203"></a>00203 T* object_;
<a name="l00204"></a>00204 MemberType member_;
<a name="l00205"></a>00205 };
<a name="l00206"></a>00206
<a name="l00209"></a>00209 <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;
<a name="l00210"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html">00210</a> <span class="keyword">class </span>KUDU_EXPORT <a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html" title="The status callback that invokes a function by pointer with a single argument.">KuduStatusFunctionCallback</a> : <span class="keyword">public</span> <a class="code" href="classkudu_1_1client_1_1KuduStatusCallback.html" title="The interface for all status callbacks.">KuduStatusCallback</a> {
<a name="l00211"></a>00211 <span class="keyword">public</span>:
<a name="l00213"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#ac175e6c42840c7a0dfbde3d71beac394">00213</a> <span class="keyword">typedef</span> void (*FunctionType)(T arg, <span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&amp;#39;s outcome.">Status</a>&amp; s);
<a name="l00214"></a>00214
<a name="l00222"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#aca289bbf6ad9720bd74a90550f6c9b3b">00222</a> <a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html" title="The status callback that invokes a function by pointer with a single argument.">KuduStatusFunctionCallback</a>(FunctionType function, T arg)
<a name="l00223"></a>00223 : function_(function),
<a name="l00224"></a>00224 arg_(arg) {
<a name="l00225"></a>00225 }
<a name="l00226"></a>00226
<a name="l00228"></a><a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#af4c3e7fbd4fed52bcba220f95a27f70a">00228</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classkudu_1_1client_1_1KuduStatusFunctionCallback.html#af4c3e7fbd4fed52bcba220f95a27f70a">Run</a>(<span class="keyword">const</span> <a class="code" href="classkudu_1_1Status.html" title="A representation of an operation&amp;#39;s outcome.">Status</a>&amp; s) OVERRIDE {
<a name="l00229"></a>00229 function_(arg_, s);
<a name="l00230"></a>00230 }
<a name="l00231"></a>00231
<a name="l00232"></a>00232 <span class="keyword">private</span>:
<a name="l00233"></a>00233 FunctionType function_;
<a name="l00234"></a>00234 T arg_;
<a name="l00235"></a>00235 };
<a name="l00236"></a>00236
<a name="l00237"></a>00237 } <span class="comment">// namespace client</span>
<a name="l00238"></a>00238 } <span class="comment">// namespace kudu</span>
<a name="l00239"></a>00239
<a name="l00240"></a>00240 <span class="preprocessor">#endif</span>
</pre></div></div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&nbsp;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&nbsp;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&nbsp;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<!-- start footer part -->
<hr class="footer"/>
<address class="footer">
<small>Generated for Kudu version 1.0.1 on Tue Oct 11 08:52:01 2016 by Doxygen 1.6.1</small>
<br>
<small>Copyright © 2016 The Apache Software Foundation.</small>
</address>
</body>
</html>