| <!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_provider.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.IPluginProvider< in in TConfig > Interface 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="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_provider.html','');}); |
| </script> |
| <div id="doc-content"> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Ignite.Core.Plugin.IPluginProvider< in in TConfig > Interface Template Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Pluggable Ignite component. Should have parameterless constructor. |
| <a href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.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:acad70546693c2bfd163189ff8ab09b44"><td class="memItemLeft" align="right" valign="top">T </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_provider.html#acad70546693c2bfd163189ff8ab09b44">GetPlugin< T ></a> ()</td></tr> |
| <tr class="memdesc:acad70546693c2bfd163189ff8ab09b44"><td class="mdescLeft"> </td><td class="mdescRight">Gets the plugin instance. <a href="#acad70546693c2bfd163189ff8ab09b44">More...</a><br /></td></tr> |
| <tr class="separator:acad70546693c2bfd163189ff8ab09b44"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a62b45fb36556593a92bef0e9b9a209b9"><td class="memItemLeft" align="right" valign="top">void </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_provider.html#a62b45fb36556593a92bef0e9b9a209b9">Start</a> (<a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_context.html">IPluginContext</a>< TConfig > context)</td></tr> |
| <tr class="memdesc:a62b45fb36556593a92bef0e9b9a209b9"><td class="mdescLeft"> </td><td class="mdescRight">Starts the plugin provider. <a href="#a62b45fb36556593a92bef0e9b9a209b9">More...</a><br /></td></tr> |
| <tr class="separator:a62b45fb36556593a92bef0e9b9a209b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab8fe04dff2eb6b0e37d80226d619f41a"><td class="memItemLeft" align="right" valign="top">void </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_provider.html#ab8fe04dff2eb6b0e37d80226d619f41a">Stop</a> (bool cancel)</td></tr> |
| <tr class="memdesc:ab8fe04dff2eb6b0e37d80226d619f41a"><td class="mdescLeft"> </td><td class="mdescRight">Stops the plugin provider. <a href="#ab8fe04dff2eb6b0e37d80226d619f41a">More...</a><br /></td></tr> |
| <tr class="separator:ab8fe04dff2eb6b0e37d80226d619f41a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab7335801468ab577b10b63cb574d8266"><td class="memItemLeft" align="right" valign="top">void </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_provider.html#ab7335801468ab577b10b63cb574d8266">OnIgniteStart</a> ()</td></tr> |
| <tr class="memdesc:ab7335801468ab577b10b63cb574d8266"><td class="mdescLeft"> </td><td class="mdescRight">Called when Ignite has been started and is fully functional. <a href="#ab7335801468ab577b10b63cb574d8266">More...</a><br /></td></tr> |
| <tr class="separator:ab7335801468ab577b10b63cb574d8266"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1b25bfb776d3ca572a8067dbdee5b77e"><td class="memItemLeft" align="right" valign="top">void </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_provider.html#a1b25bfb776d3ca572a8067dbdee5b77e">OnIgniteStop</a> (bool cancel)</td></tr> |
| <tr class="memdesc:a1b25bfb776d3ca572a8067dbdee5b77e"><td class="mdescLeft"> </td><td class="mdescRight">Callback to notify that Ignite is about to stop. <a href="#a1b25bfb776d3ca572a8067dbdee5b77e">More...</a><br /></td></tr> |
| <tr class="separator:a1b25bfb776d3ca572a8067dbdee5b77e"><td class="memSeparator" colspan="2"> </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:acdaac98a7ea502aeec4287040eba8fe7"><td class="memItemLeft" align="right" valign="top">string </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_provider.html#acdaac98a7ea502aeec4287040eba8fe7">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:acdaac98a7ea502aeec4287040eba8fe7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the plugin name. Plugins can be retrieved by name via <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_i_ignite.html#a841981508ea87d7736bfe4b246193818" title="Gets the plugin by name. ">IIgnite.GetPlugin<T></a>. <a href="#acdaac98a7ea502aeec4287040eba8fe7">More...</a><br /></td></tr> |
| <tr class="separator:acdaac98a7ea502aeec4287040eba8fe7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a55058609cc9916c1836c80e783767dc7"><td class="memItemLeft" align="right" valign="top">string </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_provider.html#a55058609cc9916c1836c80e783767dc7">Copyright</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a55058609cc9916c1836c80e783767dc7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the copyright information. <a href="#a55058609cc9916c1836c80e783767dc7">More...</a><br /></td></tr> |
| <tr class="separator:a55058609cc9916c1836c80e783767dc7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Ignite plugins are loaded according to <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_ignite_configuration.html#a17f681feaae5d28cb34cbd8a97306417" title="Gets or sets the configurations for plugins to be started. ">IgniteConfiguration.PluginConfigurations</a>. </p> |
| <div class="typeconstraint"> |
| <dl><dt><b>Type Constraints</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em>TConfig</em></td><td> :</td><td valign="top"><em><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_configuration.html">IPluginConfiguration</a></em></td><td> </td></tr> |
| </table> |
| </dl> |
| </div> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="acad70546693c2bfd163189ff8ab09b44"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">T <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.GetPlugin< T > </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>Plugin instance type.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Plugin instance.</dd></dl> |
| <div class="typeconstraint"> |
| <dl><dt><b>Type Constraints</b></dt><dd> |
| <table border="0" cellspacing="2" cellpadding="0"> |
| <tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>class</em></td><td> </td></tr> |
| </table> |
| </dl> |
| </div> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab7335801468ab577b10b63cb574d8266"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.OnIgniteStart </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1b25bfb776d3ca572a8067dbdee5b77e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.OnIgniteStop </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>cancel</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">cancel</td><td>if set to <code>true</code>, all ongoing operations should be canceled.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a62b45fb36556593a92bef0e9b9a209b9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.Start </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_context.html">IPluginContext</a>< TConfig > </td> |
| <td class="paramname"><em>context</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_context.html#aa3da3fab5d0cda4e34d4532fcedbac5c" title="Gets the Ignite. ">IPluginContext<T>.Ignite</a> can be null until <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html#ab7335801468ab577b10b63cb574d8266" title="Called when Ignite has been started and is fully functional. ">OnIgniteStart</a> is called. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">context</td><td>The context.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab8fe04dff2eb6b0e37d80226d619f41a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.Stop </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>cancel</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">cancel</td><td>if set to <code>true</code>, all ongoing operations should be canceled.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a55058609cc9916c1836c80e783767dc7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.Copyright</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> |
| <a class="anchor" id="acdaac98a7ea502aeec4287040eba8fe7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">string <a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_plugin_1_1_i_plugin_provider.html">Apache.Ignite.Core.Plugin.IPluginProvider</a>< in in TConfig >.Name</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_provider.html">IPluginProvider</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> |
