gemfire::MirrorType Class Reference


Detailed Description

Enumerated type for region mirroring.

See also:
AttributesFactory::setMirrorType

RegionAttributes::getMirrorType


Public Types

enum  Mirror { NONE = 0, KEYS, KEYS_VALUES }
 Values for Mirroring type. More...

Static Public Member Functions

static const char * fromOrdinal (const uint8_t ordinal)
 Return the MirrorType represented by the specified ordinal.
static bool isKeys (const Mirror type)
 Return whether this is KEYS.
static bool isKeysValues (const Mirror type)
 Return whether this is KEYS_VALUES.
static bool isMirrored (const Mirror type)
 Return whether this indicates a mirrored type.
static bool isNone (const Mirror type)
 Return whether this is NONE.
static Mirror toMirrorType (const char *name)
 Returns the type from the name.

Member Enumeration Documentation

enum gemfire::MirrorType::Mirror

Values for Mirroring type.

Enumerator:
NONE  No mirroring.

KEYS  Mirror only region keys.

KEYS_VALUES  Full mirroring of keys and values from other processes.


Member Function Documentation

static const char* gemfire::MirrorType::fromOrdinal ( const uint8_t  ordinal  )  [static]

Return the MirrorType represented by the specified ordinal.

Parameters:
ordinal enumeration index value

static bool gemfire::MirrorType::isKeys ( const Mirror  type  )  [inline, static]

Return whether this is KEYS.

Parameters:
type mirror type

static bool gemfire::MirrorType::isKeysValues ( const Mirror  type  )  [inline, static]

Return whether this is KEYS_VALUES.

Parameters:
type mirror type

static bool gemfire::MirrorType::isMirrored ( const Mirror  type  )  [inline, static]

Return whether this indicates a mirrored type.

Parameters:
type mirror type
Returns:
true if KEYS or KEYS_VALUES

static bool gemfire::MirrorType::isNone ( const Mirror  type  )  [inline, static]

Return whether this is NONE.

Parameters:
type mirror type

static Mirror gemfire::MirrorType::toMirrorType ( const char *  name  )  [static]

Returns the type from the name.

Returns:
the type enumeration value


GemFire C++ Cache API Documentation