blob: ea4d5edb96be1707ad66bab58701ecfea8b57249 [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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.2.0/dotnetdoc/interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.9.1"/>
<title>Apache Ignite.NET: Apache.Ignite.Core.Plugin.IPluginConfiguration Interface 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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 style="padding-left: 0.5em;">
<div id="projectname">Apache Ignite.NET
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Ignite.Core.Plugin.IPluginConfiguration Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Plugin configuration interface.
<a href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html#details">More...</a></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:aa94718a445d0ceeb491f58f87dc190f3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html#aa94718a445d0ceeb491f58f87dc190f3">WriteBinary</a> (<a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_binary_1_1_i_binary_raw_writer.html">IBinaryRawWriter</a> writer)</td></tr>
<tr class="memdesc:aa94718a445d0ceeb491f58f87dc190f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes this instance to a raw writer. This method will be called when <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html#ab4ed51c27b1114ea27961b96175d79e4" title="Gets the id to locate PlatformPluginConfigurationClosureFactory on Java side and read the data writte...">PluginConfigurationClosureFactoryId</a> is not null to propagate configuration to the Java side. <a href="#aa94718a445d0ceeb491f58f87dc190f3">More...</a><br /></td></tr>
<tr class="separator:aa94718a445d0ceeb491f58f87dc190f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ab4ed51c27b1114ea27961b96175d79e4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html#ab4ed51c27b1114ea27961b96175d79e4">PluginConfigurationClosureFactoryId</a><code> [get]</code></td></tr>
<tr class="memdesc:ab4ed51c27b1114ea27961b96175d79e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the id to locate PlatformPluginConfigurationClosureFactory on Java side and read the data written by <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html#aa94718a445d0ceeb491f58f87dc190f3" title="Writes this instance to a raw writer. This method will be called when PluginConfigurationClosureFacto...">WriteBinary</a> method. <a href="#ab4ed51c27b1114ea27961b96175d79e4">More...</a><br /></td></tr>
<tr class="separator:ab4ed51c27b1114ea27961b96175d79e4"><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>Implementations should be linked to corresponding IPluginProvider&lt;TConfig&gt; via <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_plugin_provider_type_attribute.html" title="When applied to IPluginConfiguration, defines the type of IPluginProvider<T> to instantiate. ">PluginProviderTypeAttribute</a>. </p>
<p>Example plugin implementation: </p><div class="fragment"><div class="line">[PluginProviderType(typeof(MyPluginProvider))]</div>
<div class="line"><span class="keyword">class </span>MyPluginConfig : IPluginConfiguration</div>
<div class="line">{</div>
<div class="line"> <span class="keywordtype">int</span> CustomProperty { <span class="keyword">get</span>; set; }</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keyword">class </span>MyPluginProvider : IPluginProvider&lt;MyPluginConfig&gt;</div>
<div class="line">{</div>
<div class="line"> ...</div>
<div class="line">}</div>
</div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa94718a445d0ceeb491f58f87dc190f3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Apache.Ignite.Core.Plugin.IPluginConfiguration.WriteBinary </td>
<td>(</td>
<td class="paramtype"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_binary_1_1_i_binary_raw_writer.html">IBinaryRawWriter</a>&#160;</td>
<td class="paramname"><em>writer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">writer</td><td>The writer.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ab4ed51c27b1114ea27961b96175d79e4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Ignite.Core.Plugin.IPluginConfiguration.PluginConfigurationClosureFactoryId</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_apache.html">Apache</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite.html">Ignite</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core.html">Core</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core_1_1_plugin.html">Plugin</a></li><li class="navelem"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html">IPluginConfiguration</a></li>
<li class="footer">Generated on Fri Sep 15 2017 11:37:30 for Apache Ignite.NET by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>