blob: 8c2a51868ca513d386f3cb64151b83e248d75db5 [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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>&nbsp; Apache Ignite C++: ignite::IgniteBinding 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>
<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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="classignite_1_1IgniteBinding.html">IgniteBinding</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1IgniteBinding-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::IgniteBinding Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Ignite Binding.
<a href="classignite_1_1IgniteBinding.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ignite__binding_8h_source.html">ignite_binding.h</a>&gt;</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:a48a001ba64f79f5fa164114e29ea968a"><td class="memItemLeft" align="right" valign="top"><a id="a48a001ba64f79f5fa164114e29ea968a"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#a48a001ba64f79f5fa164114e29ea968a">IgniteBinding</a> ()</td></tr>
<tr class="memdesc:a48a001ba64f79f5fa164114e29ea968a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a48a001ba64f79f5fa164114e29ea968a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afafd6de3294259ec46ccf0c9655e74dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#afafd6de3294259ec46ccf0c9655e74dc">IgniteBinding</a> (common::concurrent::SharedPointer&lt; impl::IgniteBindingImpl &gt; impl)</td></tr>
<tr class="memdesc:afafd6de3294259ec46ccf0c9655e74dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classignite_1_1IgniteBinding.html#afafd6de3294259ec46ccf0c9655e74dc">More...</a><br /></td></tr>
<tr class="separator:afafd6de3294259ec46ccf0c9655e74dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1deb2ba19e1b0e15b8a8f2779daf134"><td class="memTemplParams" colspan="2">template&lt;typename P &gt; </td></tr>
<tr class="memitem:ae1deb2ba19e1b0e15b8a8f2779daf134"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#ae1deb2ba19e1b0e15b8a8f2779daf134">RegisterCacheEntryProcessor</a> ()</td></tr>
<tr class="memdesc:ae1deb2ba19e1b0e15b8a8f2779daf134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register type as Cache Entry Processor. <a href="classignite_1_1IgniteBinding.html#ae1deb2ba19e1b0e15b8a8f2779daf134">More...</a><br /></td></tr>
<tr class="separator:ae1deb2ba19e1b0e15b8a8f2779daf134"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8734cf722ced2913dbe5c2630790a2dd"><td class="memTemplParams" colspan="2">template&lt;typename P &gt; </td></tr>
<tr class="memitem:a8734cf722ced2913dbe5c2630790a2dd"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#a8734cf722ced2913dbe5c2630790a2dd">RegisterCacheEntryProcessor</a> (<a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;err)</td></tr>
<tr class="memdesc:a8734cf722ced2913dbe5c2630790a2dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register Type as Cache Entry Processor. <a href="classignite_1_1IgniteBinding.html#a8734cf722ced2913dbe5c2630790a2dd">More...</a><br /></td></tr>
<tr class="separator:a8734cf722ced2913dbe5c2630790a2dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33cd694af8056de416ca7ea090e7c67d"><td class="memTemplParams" colspan="2">template&lt;typename F &gt; </td></tr>
<tr class="memitem:a33cd694af8056de416ca7ea090e7c67d"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#a33cd694af8056de416ca7ea090e7c67d">RegisterCacheEntryEventFilter</a> ()</td></tr>
<tr class="memdesc:a33cd694af8056de416ca7ea090e7c67d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register type as Cache Entry Event Filter. <a href="classignite_1_1IgniteBinding.html#a33cd694af8056de416ca7ea090e7c67d">More...</a><br /></td></tr>
<tr class="separator:a33cd694af8056de416ca7ea090e7c67d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25339becdaa6ea01c6ef26666d4ec8da"><td class="memTemplParams" colspan="2">template&lt;typename F &gt; </td></tr>
<tr class="memitem:a25339becdaa6ea01c6ef26666d4ec8da"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#a25339becdaa6ea01c6ef26666d4ec8da">RegisterComputeFunc</a> ()</td></tr>
<tr class="memdesc:a25339becdaa6ea01c6ef26666d4ec8da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register type as Compute function. <a href="classignite_1_1IgniteBinding.html#a25339becdaa6ea01c6ef26666d4ec8da">More...</a><br /></td></tr>
<tr class="separator:a25339becdaa6ea01c6ef26666d4ec8da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36ce832f3a3151bf7b4e2bdaa9002107"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1IgniteBinding.html#a36ce832f3a3151bf7b4e2bdaa9002107">IsValid</a> () const</td></tr>
<tr class="memdesc:a36ce832f3a3151bf7b4e2bdaa9002107"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the instance is valid. <a href="classignite_1_1IgniteBinding.html#a36ce832f3a3151bf7b4e2bdaa9002107">More...</a><br /></td></tr>
<tr class="separator:a36ce832f3a3151bf7b4e2bdaa9002107"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Ignite Binding. </p>
<p>Used to register callable classes. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afafd6de3294259ec46ccf0c9655e74dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afafd6de3294259ec46ccf0c9655e74dc">&#9670;&nbsp;</a></span>IgniteBinding()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ignite::IgniteBinding::IgniteBinding </td>
<td>(</td>
<td class="paramtype">common::concurrent::SharedPointer&lt; impl::IgniteBindingImpl &gt;&#160;</td>
<td class="paramname"><em>impl</em></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>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">impl</td><td>Implementation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a36ce832f3a3151bf7b4e2bdaa9002107"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36ce832f3a3151bf7b4e2bdaa9002107">&#9670;&nbsp;</a></span>IsValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ignite::IgniteBinding::IsValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Check if the instance is valid. </p>
<p>Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.</p>
<dl class="section return"><dt>Returns</dt><dd>True if the instance is valid and can be used. </dd></dl>
</div>
</div>
<a id="a33cd694af8056de416ca7ea090e7c67d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33cd694af8056de416ca7ea090e7c67d">&#9670;&nbsp;</a></span>RegisterCacheEntryEventFilter()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename F &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ignite::IgniteBinding::RegisterCacheEntryEventFilter </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">
<p>Register type as Cache Entry Event Filter. </p>
<p>Registred type should be a child of <a class="el" href="classignite_1_1cache_1_1event_1_1CacheEntryEventFilter.html" title="Cache entry event filter.">ignite::cache::event::CacheEntryEventFilter</a> class. </p>
</div>
</div>
<a id="ae1deb2ba19e1b0e15b8a8f2779daf134"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1deb2ba19e1b0e15b8a8f2779daf134">&#9670;&nbsp;</a></span>RegisterCacheEntryProcessor() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename P &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ignite::IgniteBinding::RegisterCacheEntryProcessor </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">
<p>Register type as Cache Entry Processor. </p>
<p>Registred type should be a child of <a class="el" href="classignite_1_1cache_1_1CacheEntryProcessor.html" title="Cache entry processor class template.">ignite::cache::CacheEntryProcessor</a> class. </p>
</div>
</div>
<a id="a8734cf722ced2913dbe5c2630790a2dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8734cf722ced2913dbe5c2630790a2dd">&#9670;&nbsp;</a></span>RegisterCacheEntryProcessor() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename P &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ignite::IgniteBinding::RegisterCacheEntryProcessor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &amp;&#160;</td>
<td class="paramname"><em>err</em></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>Register Type as Cache Entry Processor. </p>
<p>Registred type should be a child of <a class="el" href="classignite_1_1cache_1_1CacheEntryProcessor.html" title="Cache entry processor class template.">ignite::cache::CacheEntryProcessor</a> class.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a25339becdaa6ea01c6ef26666d4ec8da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25339becdaa6ea01c6ef26666d4ec8da">&#9670;&nbsp;</a></span>RegisterComputeFunc()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename F &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ignite::IgniteBinding::RegisterComputeFunc </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">
<p>Register type as Compute function. </p>
<p>Registred type should be a child of <a class="el" href="classignite_1_1compute_1_1ComputeFunc.html" title="Interface for a simple compute function that can be serialized and called on the remote nodes.">ignite::compute::ComputeFunc</a> class. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ignite__binding_8h_source.html">ignite_binding.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>