GridGain C++ Client Library
Static Public Member Functions | List of all members
gridgain::GridFactory Class Reference

This class defines a factory for the main GridGain API. More...

#include <grid_factory.h>

Static Public Member Functions

static Grid Start (const GridConfiguration &cfg)
 Start grid instance. More...
 
static Grid Start (const GridConfiguration &cfg, GridError *err)
 Start grid instance. More...
 
static Grid Start (const GridConfiguration &cfg, const char *name)
 Start grid instance with specific name. More...
 
static Grid Start (const GridConfiguration &cfg, const char *name, GridError *err)
 Start grid instance with specific name. More...
 
static Grid Get ()
 Get default grid instance. More...
 
static Grid Get (GridError *err)
 Get default grid instance. More...
 
static Grid Get (const char *name)
 Get grid instance with the given name. More...
 
static Grid Get (const char *name, GridError *err)
 Get grid instance with the given name. More...
 
static bool Stop (bool cancel)
 Stop default grid instance. More...
 
static bool Stop (bool cancel, GridError *err)
 Stop default grid instance. More...
 
static bool Stop (const char *name, bool cancel)
 Stop grid instance with the given name. More...
 
static bool Stop (const char *name, bool cancel, GridError *err)
 Stop grid instance with the given name. More...
 
static void StopAll (bool cancel)
 Stop all running grid instances. More...
 
static void StopAll (bool cancel, GridError *err)
 Stop all running grid instances. More...
 

Detailed Description

This class defines a factory for the main GridGain API.

Member Function Documentation

Grid gridgain::GridFactory::Get ( )
static

Get default grid instance.

Returns
Grid instance.
Grid gridgain::GridFactory::Get ( GridError *  err)
static

Get default grid instance.

Parameters
errError.
Returns
Grid instance.
Grid gridgain::GridFactory::Get ( const char *  name)
static

Get grid instance with the given name.

Parameters
nameGrid name.
Returns
Grid instance.
Grid gridgain::GridFactory::Get ( const char *  name,
GridError *  err 
)
static

Get grid instance with the given name.

Parameters
nameGrid name.
errError.
Returns
Grid instance.
Grid gridgain::GridFactory::Start ( const GridConfiguration &  cfg)
static

Start grid instance.

Parameters
cfgConfiguration.
Returns
Grid instance.
Grid gridgain::GridFactory::Start ( const GridConfiguration &  cfg,
GridError *  err 
)
static

Start grid instance.

Parameters
cfgConfiguration.
errError.
Returns
Grid instance.
Grid gridgain::GridFactory::Start ( const GridConfiguration &  cfg,
const char *  name 
)
static

Start grid instance with specific name.

Parameters
cfgConfiguration.
nameGrid name.
Returns
Grid instance.
Grid gridgain::GridFactory::Start ( const GridConfiguration &  cfg,
const char *  name,
GridError *  err 
)
static

Start grid instance with specific name.

Parameters
cfgConfiguration.
nameGrid name.
errError.
Returns
Grid instance.
bool gridgain::GridFactory::Stop ( bool  cancel)
static

Stop default grid instance.

Parameters
cancelCancel flag.
Returns
True if grid instance was stopped by this call.
bool gridgain::GridFactory::Stop ( bool  cancel,
GridError *  err 
)
static

Stop default grid instance.

Parameters
cancelCancel flag.
errError.
Returns
True if grid instance was stopped by this call.
bool gridgain::GridFactory::Stop ( const char *  name,
bool  cancel 
)
static

Stop grid instance with the given name.

Parameters
nameGrid name.
cancelCancel flag.
Returns
True if grid instance was stopped by this call.
bool gridgain::GridFactory::Stop ( const char *  name,
bool  cancel,
GridError *  err 
)
static

Stop grid instance with the given name.

Parameters
nameGrid name.
cancelCancel flag.
errError.
Returns
True if grid instance was stopped by this call.
void gridgain::GridFactory::StopAll ( bool  cancel)
static

Stop all running grid instances.

Parameters
cancelCancel flag.
void gridgain::GridFactory::StopAll ( bool  cancel,
GridError *  err 
)
static

Stop all running grid instances.

Parameters
cancelCancel flag.
errError.

The documentation for this class was generated from the following files: