| <!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.15"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Apache Geode Native .NET Reference: Apache::Geode::Client::DistributedSystem 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="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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(initResizable); |
| /* @license-end */</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="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Geode Native .NET Reference |
|  <span id="projectnumber">1.13.1</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.15 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&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&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> |
| </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"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('a00614.html','');}); |
| /* @license-end */ |
| </script> |
| <div id="doc-content"> |
| <!-- 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 class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache::Geode::Client::DistributedSystem Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a> encapsulates this applications "connection" into the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers. |
| <a href="a00614.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:a0e1fbe633fe9ca276d086b8917fcfb32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00614.html">DistributedSystem</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00614.html#a0e1fbe633fe9ca276d086b8917fcfb32">Connect</a> (String^ name, <a class="el" href="a00410.html">Cache</a>^ cache)</td></tr> |
| <tr class="memdesc:a0e1fbe633fe9ca276d086b8917fcfb32"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> system to be able to connect to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers. <a href="#a0e1fbe633fe9ca276d086b8917fcfb32">More...</a><br /></td></tr> |
| <tr class="separator:a0e1fbe633fe9ca276d086b8917fcfb32"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2479ad1f3116a30764ca188397036a7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00614.html#a2479ad1f3116a30764ca188397036a7c">Disconnect</a> (<a class="el" href="a00410.html">Cache</a>^ cache)</td></tr> |
| <tr class="memdesc:a2479ad1f3116a30764ca188397036a7c"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the distributed system. <a href="#a2479ad1f3116a30764ca188397036a7c">More...</a><br /></td></tr> |
| <tr class="separator:a2479ad1f3116a30764ca188397036a7c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a4b38fb16a82f37389559c315b7c19959"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00614.html">DistributedSystem</a> ^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00614.html#a4b38fb16a82f37389559c315b7c19959">Connect</a> (String^ name, <a class="el" href="a00406.html">Properties</a>< String^, String^>^ config, <a class="el" href="a00410.html">Cache</a>^ cache)</td></tr> |
| <tr class="memdesc:a4b38fb16a82f37389559c315b7c19959"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> system to be able to connect to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers. <a href="#a4b38fb16a82f37389559c315b7c19959">More...</a><br /></td></tr> |
| <tr class="separator:a4b38fb16a82f37389559c315b7c19959"><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:a2242f0c4f790072c73d65ae3768df21e"><td class="memItemLeft" align="right" valign="top">String^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00614.html#a2242f0c4f790072c73d65ae3768df21e">Name</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a2242f0c4f790072c73d65ae3768df21e"><td class="mdescLeft"> </td><td class="mdescRight">Get the name that identifies this <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a> instance. <a href="#a2242f0c4f790072c73d65ae3768df21e">More...</a><br /></td></tr> |
| <tr class="separator:a2242f0c4f790072c73d65ae3768df21e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a722bbf0de4550abec48afff449f80ba3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01126.html">Apache::Geode::Client::SystemProperties</a>^ </td><td class="memItemRight" valign="bottom"><a class="el" href="a00614.html#a722bbf0de4550abec48afff449f80ba3">SystemProperties</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a722bbf0de4550abec48afff449f80ba3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="a01126.html" title="A class for internal use that encapsulates the properties that can be set through DistributedSystem....">SystemProperties</a> used to create this instance of a <code><a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a></code>. <a href="#a722bbf0de4550abec48afff449f80ba3">More...</a><br /></td></tr> |
| <tr class="separator:a722bbf0de4550abec48afff449f80ba3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p><a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a> encapsulates this applications "connection" into the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers. </p> |
| <p>In order to participate as a client in the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers distributed system, each application needs to connect to the <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0e1fbe633fe9ca276d086b8917fcfb32"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0e1fbe633fe9ca276d086b8917fcfb32">◆ </a></span>Connect() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="a00614.html">DistributedSystem</a> ^ Apache::Geode::Client::DistributedSystem::Connect </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="a00410.html">Cache</a>^ </td> |
| <td class="paramname"><em>cache</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> system to be able to connect to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the system to connect to</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if name is null</td></tr> |
| <tr><td class="paramname"><a class="el" href="a00686.html" title="Thrown when the connecting target is not running.">NoSystemException</a></td><td>if the connecting target is not running </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00690.html" title="Thrown when an attempt is made to connect to DistributedSystem second time.">AlreadyConnectedException</a></td><td>if trying a second connect. An application can have one only one connection to a <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a>. </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>otherwise</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a4b38fb16a82f37389559c315b7c19959"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a4b38fb16a82f37389559c315b7c19959">◆ </a></span>Connect() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="a00614.html">DistributedSystem</a> ^ Apache::Geode::Client::DistributedSystem::Connect </td> |
| <td>(</td> |
| <td class="paramtype">String^ </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="a00406.html">Properties</a>< String^, String^>^ </td> |
| <td class="paramname"><em>config</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="a00410.html">Cache</a>^ </td> |
| <td class="paramname"><em>cache</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the Native <a class="el" href="a00382.html" title="This namespace contains all the Geode .NET Generics API classes and enumerations.">Client</a> system to be able to connect to the <a class="el" href="a00381.html" title="This namespace contains all the Geode .NET classes and utility classes.">Geode</a> Java servers. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>the name of the system to connect to</td></tr> |
| <tr><td class="paramname">config</td><td>the set of properties</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00634.html" title="Thrown when an argument to a method is illegal.">IllegalArgumentException</a></td><td>if name is null</td></tr> |
| <tr><td class="paramname"><a class="el" href="a00686.html" title="Thrown when the connecting target is not running.">NoSystemException</a></td><td>if the connecting target is not running </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00690.html" title="Thrown when an attempt is made to connect to DistributedSystem second time.">AlreadyConnectedException</a></td><td>if trying a second connect. An application can have one only one connection to a <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a>. </td></tr> |
| <tr><td class="paramname"><a class="el" href="a00714.html" title="An unknown exception occurred.">UnknownException</a></td><td>otherwise</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a2479ad1f3116a30764ca188397036a7c"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2479ad1f3116a30764ca188397036a7c">◆ </a></span>Disconnect()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache::Geode::Client::DistributedSystem::Disconnect </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="a00410.html">Cache</a>^ </td> |
| <td class="paramname"><em>cache</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Disconnect from the distributed system. </p> |
| <dl class="exception"><dt>Exceptions</dt><dd> |
| <table class="exception"> |
| <tr><td class="paramname"><a class="el" href="a00638.html" title="Thrown when the state of cache is manipulated to be illegal.">IllegalStateException</a></td><td>if not connected</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="a2242f0c4f790072c73d65ae3768df21e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2242f0c4f790072c73d65ae3768df21e">◆ </a></span>Name</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">String^ Apache::Geode::Client::DistributedSystem::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"> |
| |
| <p>Get the name that identifies this <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a> instance. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the name of the <a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a> instance.</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a722bbf0de4550abec48afff449f80ba3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a722bbf0de4550abec48afff449f80ba3">◆ </a></span>SystemProperties</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache:: Geode:: Client:: <a class="el" href="a01126.html">SystemProperties</a>^ Apache::Geode::Client::DistributedSystem::SystemProperties</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the <a class="el" href="a01126.html" title="A class for internal use that encapsulates the properties that can be set through DistributedSystem....">SystemProperties</a> used to create this instance of a <code><a class="el" href="a00614.html" title="DistributedSystem encapsulates this applications "connection" into the Geode Java servers.">DistributedSystem</a></code>. </p> |
| <dl class="section return"><dt>Returns</dt><dd>the <a class="el" href="a01126.html" title="A class for internal use that encapsulates the properties that can be set through DistributedSystem....">SystemProperties</a></dd></dl> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <HR><address style="align: right;"><small>Apache Geode C++ Cache .NET API Documentation</small></address> |
