Apache Geode Native .NET Reference 1.15.0
Apache::Geode::Client::DistributedSystem Class Reference

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

#include <DistributedSystem.hpp>

Public Member Functions

DistributedSystemConnect (String^ name, Cache^ cache)
 Initializes the Native Client system to be able to connect to the Geode Java servers. More...
 
void Disconnect (Cache^ cache)
 Disconnect from the distributed system. More...
 

Static Public Member Functions

static DistributedSystemConnect (String^ name, Properties< String^, String^>^ config, Cache^ cache)
 Initializes the Native Client system to be able to connect to the Geode Java servers. More...
 

Properties

String^ Name [get]
 Get the name that identifies this DistributedSystem instance. More...
 
Apache::Geode::Client::SystemPropertiesSystemProperties [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

◆ Connect() [1/2]

DistributedSystem ^ Apache::Geode::Client::DistributedSystem::Connect ( String^  name,
Cache cache 
)

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

◆ Connect() [2/2]

static DistributedSystem ^ Apache::Geode::Client::DistributedSystem::Connect ( String^  name,
Properties< String^, String^>^  config,
Cache cache 
)
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

◆ Disconnect()

void Apache::Geode::Client::DistributedSystem::Disconnect ( Cache cache)

Disconnect from the distributed system.

Exceptions
IllegalStateExceptionif not connected

Property Documentation

◆ Name

String^ Apache::Geode::Client::DistributedSystem::Name
get

Get the name that identifies this DistributedSystem instance.

Returns
the name of the DistributedSystem instance.

◆ SystemProperties

Apache:: Geode:: Client:: SystemProperties^ Apache::Geode::Client::DistributedSystem::SystemProperties
get

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

Returns
the SystemProperties

Apache Geode C++ Cache .NET API Documentation