VMware GemFire Native .NET Reference  9.1
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Properties Macros
Apache::Geode::Client::DistributedSystem Class Reference

DistributedSystem encapsulates this applications "connection" into the Geode Java servers. More...

Inherits SBWrap< apache::geode::client::DistributedSystem >.

Static Public Member Functions

static DistributedSystemConnect (String^ name)
 Initializes the Native Client system to be able to connect to the Geode Java servers. More...
 
static DistributedSystemConnect (String^ name, Properties< String^ , String^ >^config)
 Initializes the Native Client system to be able to connect to the Geode Java servers. More...
 
static void Disconnect ()
 Disconnect from the distributed system. More...
 
static DistributedSystemGetInstance ()
 Returns a reference to this DistributedSystem instance. More...
 

Properties

static bool IsConnected [get]
 The current connection status of this client to the DistributedSystem. More...
 
String^  Name [get]
 Get the name that identifies this DistributedSystem instance. More...
 
static Apache::Geode::Client::SystemProperties^  SystemProperties [get]
 Returns the SystemProperties used to create this instance of a DistributedSystem. More...
 

Detailed Description

DistributedSystem encapsulates this applications "connection" into the Geode Java servers.

In order to participate as a client in the Geode Java servers distributed system, each application needs to connect to the DistributedSystem.

Member Function Documentation

static DistributedSystem ^ Apache::Geode::Client::DistributedSystem::Connect ( String^  name)
static

Initializes the Native Client system to be able to connect to the Geode Java servers.

Parameters
namethe name of the system to connect to
Exceptions
IllegalArgumentExceptionif name is null
NoSystemExceptionif the connecting target is not running
AlreadyConnectedExceptionif trying a second connect. An application can have one only one connection to a DistributedSystem.
UnknownExceptionotherwise
static DistributedSystem ^ Apache::Geode::Client::DistributedSystem::Connect ( String^  name,
Properties< String^ , String^ >^  config 
)
static

Initializes the Native Client system to be able to connect to the Geode Java servers.

Parameters
namethe name of the system to connect to
configthe set of properties
Exceptions
IllegalArgumentExceptionif name is null
NoSystemExceptionif the connecting target is not running
AlreadyConnectedExceptionif trying a second connect. An application can have one only one connection to a DistributedSystem.
UnknownExceptionotherwise
static void Apache::Geode::Client::DistributedSystem::Disconnect ( )
static

Disconnect from the distributed system.

Exceptions
IllegalStateExceptionif not connected
static DistributedSystem ^ Apache::Geode::Client::DistributedSystem::GetInstance ( )
static

Returns a reference to this DistributedSystem instance.

Returns
the DistributedSystem instance

Property Documentation

bool Apache::Geode::Client::DistributedSystem::IsConnected
staticget

The current connection status of this client to the DistributedSystem.

Returns
true if connected, false otherwise
String^ Apache::Geode::Client::DistributedSystem::Name
get

Get the name that identifies this DistributedSystem instance.

Returns
the name of the DistributedSystem instance.
Apache:: Geode:: Client:: SystemProperties^ Apache::Geode::Client::DistributedSystem::SystemProperties
staticget

Returns the SystemProperties used to create this instance of a DistributedSystem.

Returns
the SystemProperties

Pivotal GemFire .NET Cache API Documentation