gemfire::DistributedSystem Class Reference

Inherits gemfire::SharedBase.


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

virtual const char * getName () const
 Returns the name that identifies the distributed system instance.
void preserveSB () const
 Atomically increment reference count.
int32_t refCount ()
 
Returns:
the reference count

void releaseSB () const
 Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
virtual ~DistributedSystem ()

Static Public Member Functions

static
DistributedSystemPtr 
connect (const char *name, const PropertiesPtr &configPtr=gemfire::NullSharedBase::s_instancePtr)
static void disconnect ()
static
DistributedSystemPtr 
getInstance ()
 Returns a pointer to the DistributedSystem instance.
static SystemPropertiesgetSystemProperties ()
 Returns the SystemProperties that were used to create this instance of the DistributedSystem.
static bool isConnected ()
 Returns true if connected, false otherwise.

Protected Member Functions

 DistributedSystem (const char *name)


Constructor & Destructor Documentation

virtual gemfire::DistributedSystem::~DistributedSystem (  )  [virtual]

destructor

gemfire::DistributedSystem::DistributedSystem ( const char *  name  )  [protected]

constructors


Member Function Documentation

static DistributedSystemPtr gemfire::DistributedSystem::connect ( const char *  name,
const PropertiesPtr configPtr = gemfire::NullSharedBase::s_instancePtr 
) [static]

public methods Initializes the Native Client system to be able to connect to the GemFire Java servers. If the name string is empty, then the default "NativeDS" is used as the name of distributed system.

Exceptions:
LicenseException if no valid license is found.
IllegalStateException if GFCPP variable is not set and product installation directory cannot be determined
IllegalArgument exception if DS name is NULL
AlreadyConnectedException if this call has succeeded once before for this process

static void gemfire::DistributedSystem::disconnect (  )  [static]

disconnect from the distributed system

Exceptions:
IllegalStateException if not connected

static DistributedSystemPtr gemfire::DistributedSystem::getInstance (  )  [static]

Returns a pointer to the DistributedSystem instance.

Returns:
instance

virtual const char* gemfire::DistributedSystem::getName (  )  const [virtual]

Returns the name that identifies the distributed system instance.

Returns:
name

static SystemProperties* gemfire::DistributedSystem::getSystemProperties (  )  [static]

Returns the SystemProperties that were used to create this instance of the DistributedSystem.

Returns:
SystemProperties

static bool gemfire::DistributedSystem::isConnected (  )  [static]

Returns true if connected, false otherwise.

Returns:
true if connected, false otherwise

void gemfire::SharedBase::preserveSB (  )  const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount (  )  [inline, inherited]

Returns:
the reference count

void gemfire::SharedBase::releaseSB (  )  const [inherited]

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.


GemFire C++ Cache API Documentation