blob: 5b576e011c61574a91b98306aadb9f6ea03fbae4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kudu C++ client API: kudu::client::KuduLoggingFunctionCallback&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 id="projectrow">
<td id="projectalign">
<div id="projectname">Kudu C++ client API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_1KuduLoggingFunctionCallback.html">KuduLoggingFunctionCallback</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_1KuduLoggingFunctionCallback-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">kudu::client::KuduLoggingFunctionCallback&lt; T &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The logging callback that invokes a function by pointer with a single argument.
<a href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.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::KuduLoggingFunctionCallback&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center">
<img src="classkudu_1_1client_1_1KuduLoggingFunctionCallback.png" usemap="#kudu::client::KuduLoggingFunctionCallback_3C_20T_20_3E_map" alt=""/>
<map id="kudu::client::KuduLoggingFunctionCallback_3C_20T_20_3E_map" name="kudu::client::KuduLoggingFunctionCallback_3C_20T_20_3E_map">
<area href="classkudu_1_1client_1_1KuduLoggingCallback.html" title="The interface for all logging callbacks." alt="kudu::client::KuduLoggingCallback" shape="rect" coords="0,0,284,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a309185776b93bf5e532440b4638a649d" id="r_a309185776b93bf5e532440b4638a649d"><td class="memItemLeft" align="right" valign="top"><a id="a309185776b93bf5e532440b4638a649d" name="a309185776b93bf5e532440b4638a649d"></a>
typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><b>FunctionType</b>) (T arg, KuduLogSeverity severity, const char *filename, int line_number, const struct ::tm *time, const char *message, size_t message_len)</td></tr>
<tr class="memdesc:a309185776b93bf5e532440b4638a649d"><td class="mdescLeft">&#160;</td><td class="mdescRight">A handy typedef for the function with appropriate signature. <br /></td></tr>
<tr class="separator:a309185776b93bf5e532440b4638a649d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4263c504b21e0e5827f47a902e908a2c" id="r_a4263c504b21e0e5827f47a902e908a2c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#a4263c504b21e0e5827f47a902e908a2c">KuduLoggingFunctionCallback</a> (<a class="el" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#a309185776b93bf5e532440b4638a649d">FunctionType</a> function, T arg)</td></tr>
<tr class="separator:a4263c504b21e0e5827f47a902e908a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae22e9139102f60d049c29e888c6a528d" id="r_ae22e9139102f60d049c29e888c6a528d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#ae22e9139102f60d049c29e888c6a528d">Run</a> (KuduLogSeverity severity, const char *filename, int line_number, const struct ::tm *time, const char *message, size_t message_len) OVERRIDE</td></tr>
<tr class="separator:ae22e9139102f60d049c29e888c6a528d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename T&gt;<br />
class kudu::client::KuduLoggingFunctionCallback&lt; T &gt;</div><p>The logging callback that invokes a function by pointer with a single argument. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a4263c504b21e0e5827f47a902e908a2c" name="a4263c504b21e0e5827f47a902e908a2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4263c504b21e0e5827f47a902e908a2c">&#9670;&#160;</a></span>KuduLoggingFunctionCallback()</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_1KuduLoggingFunctionCallback.html">kudu::client::KuduLoggingFunctionCallback</a>&lt; T &gt;::KuduLoggingFunctionCallback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classkudu_1_1client_1_1KuduLoggingFunctionCallback.html#a309185776b93bf5e532440b4638a649d">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_1KuduLoggingFunctionCallback.html" title="The logging callback that invokes a function by pointer with a single argument.">KuduLoggingFunctionCallback</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 logging 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="ae22e9139102f60d049c29e888c6a528d" name="ae22e9139102f60d049c29e888c6a528d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae22e9139102f60d049c29e888c6a528d">&#9670;&#160;</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_1KuduLoggingFunctionCallback.html">kudu::client::KuduLoggingFunctionCallback</a>&lt; T &gt;::Run </td>
<td>(</td>
<td class="paramtype">KuduLogSeverity&#160;</td>
<td class="paramname"><em>severity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>line_number</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct ::tm *&#160;</td>
<td class="paramname"><em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>message_len</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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<p>Log the message.</p>
<dl class="section note"><dt>Note</dt><dd>The <code>message</code> is NOT terminated with an endline.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">severity</td><td>Severity of the log message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>The name of the source file the message is originated from. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line_number</td><td>The line of the source file the message is originated from. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">time</td><td>The absolute time when the log event was generated. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>The message to log. It's not terminated with an endline. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">message_len</td><td>Number of characters in the <code>message</code>. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classkudu_1_1client_1_1KuduLoggingCallback.html#a59db98413fb312d260fcb08299bae89c">kudu::client::KuduLoggingCallback</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.17.0 on Mon Sep 4 2023 19:49:30 by Doxygen 1.9.8</small>
<br>
<small>Copyright © 2023 The Apache Software Foundation.</small>
</address>
</body>
</html>