GemStone::GemFire::Cache::DistributedSystem Class Reference

---

Detailed Description

DistributedSystem encapsulates this applications "connection" into the GemFire Java servers distributed system.

In order to participate in the GemFire Java servers distributed system, each application needs to connect to the DistributedSystem. Each application can only be connected to one DistributedSystem.

Public Member Functions
void	DeregisterMembershipListener (IMembershipListener^ callback)
	This functionality is unsupported in the Native Client Product.
array< MemberId^ >^	GetCacheServerList ()
	This functionality is unsupported in the Native Client Product.
Properties^	GetMembershipInfo (MemberId^ id)
	This functionality is unsupported in the Native Client Product.
array< MemberId^ >^	GetMembershipList ()
	This functionality is unsupported in the Native Client Product.
void	RegisterMembershipListener (IMembershipListener^ callback)
	This functionality is unsupported in the Native Client Product.
void	SendMembershipInfo (Properties^ config)
	This functionality is unsupported in the Native Client Product.
Static Public Member Functions
static DistributedSystem^	Connect (String^ name, Properties^ config, Boolean useMemberType)
static DistributedSystem^	Connect (String^ name, Properties^ config)
static DistributedSystem^	Connect (String^ name)
static void	Disconnect ()
static DistributedSystem^	GetInstance ()
Properties
static Boolean	IsConnected [get]
GemStone::GemFire::Cache::MemberId^	MemberId [get]
static GemStone::GemFire::Cache::MemberType	MemberType [get]
String^	Name [get]
static GemStone::GemFire::Cache::SystemProperties^	SystemProperties [get]

---

Member Function Documentation

static DistributedSystem ^ GemStone::GemFire::Cache::DistributedSystem::Connect	(	String^	name,
		Properties^	config,
		Boolean	useMemberType
	)			[static]

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

Parameters:

	name	the name of the system to connect to
	config	the set of properties
	useMemberType	If true (default), use the configuration property "member type". If false, always set member type to Server.

Exceptions:

	IllegalArgumentException	if name is null
	NoSystemException	if the connecting target is not running
	AlreadyConnectedException	if trying a second connect. An application can have one only one connection to a DistributedSystem.
	UnknownException	otherwise

static DistributedSystem ^ GemStone::GemFire::Cache::DistributedSystem::Connect	(	String^	name,
		Properties^	config
	)			[static]

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

Parameters:

	name	the name of the system to connect to
	config	the set of properties

Exceptions:

	IllegalArgumentException	if name is null
	NoSystemException	if the connecting target is not running
	AlreadyConnectedException	if trying a second connect. An application can have one only one connection to a DistributedSystem.
	UnknownException	otherwise

static DistributedSystem ^ GemStone::GemFire::Cache::DistributedSystem::Connect

(

String^

name

)

[static]

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

Parameters:

name

the name of the system to connect to

Exceptions:

	IllegalArgumentException	if name is null
	NoSystemException	if the connecting target is not running
	AlreadyConnectedException	if trying a second connect. An application can have one only one connection to a DistributedSystem.
	UnknownException	otherwise

void GemStone::GemFire::Cache::DistributedSystem::DeregisterMembershipListener

(

IMembershipListener^

callback

)

This functionality is unsupported in the Native Client Product.

static void GemStone::GemFire::Cache::DistributedSystem::Disconnect

(

)

[static]

Disconnect from the distributed system.

Exceptions:

IllegalStateException

if not connected.

array<MemberId^> ^ GemStone::GemFire::Cache::DistributedSystem::GetCacheServerList

(

)

This functionality is unsupported in the Native Client Product.

static DistributedSystem ^ GemStone::GemFire::Cache::DistributedSystem::GetInstance

(

)

[static]

Returns a reference to this DistributedSystem instance.

Returns:

the DistributedSystem instance

Properties ^ GemStone::GemFire::Cache::DistributedSystem::GetMembershipInfo

(

MemberId^

id

)

This functionality is unsupported in the Native Client Product.

array<MemberId^> ^ GemStone::GemFire::Cache::DistributedSystem::GetMembershipList

(

)

This functionality is unsupported in the Native Client Product.

void GemStone::GemFire::Cache::DistributedSystem::RegisterMembershipListener

(

IMembershipListener^

callback

)

This functionality is unsupported in the Native Client Product.

void GemStone::GemFire::Cache::DistributedSystem::SendMembershipInfo

(

Properties^

config

)

This functionality is unsupported in the Native Client Product.

---

Property Documentation

Boolean GemStone::GemFire::Cache::DistributedSystem::IsConnected [static, get]

The current connection status of this client to the DistributedSystem.

Returns:

true if connected, false otherwise

GemStone:: GemFire:: Cache:: MemberId^ GemStone::GemFire::Cache::DistributedSystem::MemberId [get]

Returns the MemberId used to create this Cache.

GemStone:: GemFire:: Cache:: MemberType GemStone::GemFire::Cache::DistributedSystem::MemberType [static, get]

Returns the type of this cache member

String^ GemStone::GemFire::Cache::DistributedSystem::Name [get]

Get the name that identifies this DistributedSystem instance.

Returns:

the name of the DistributedSystem instance.

GemStone:: GemFire:: Cache:: SystemProperties^ GemStone::GemFire::Cache::DistributedSystem::SystemProperties [static, get]

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

Returns:

the SystemProperties

---