Pivotal GemFire Native Client Cache Reference  9.0.6
gemfire::ScopeType Class Reference

Enumerated type for region distribution scope. More...

Public Types

Static Public Member Functions

static Scope fromName (const char *name)
 Returns the type of the Scope represented by name. More...
 
static const char * fromOrdinal (const uint8_t ordinal)
 Returns the Name of the Scope represented by specified ordinal. More...
 
static bool isAck (const Scope type)
 Returns whether acknowledgements are required for this scope. More...
 
static bool isDistributed (const Scope type)
 Returns whether this is one of the distributed scopes. More...
 
static bool isDistributedAck (const Scope type)
 Returns whether this is distributed ack scope. More...
 
static bool isDistributedNoAck (const Scope type)
 Returns whether this is distributed no ack scope. More...
 
static bool isGlobal (const Scope type)
 Returns whether this is global scope. More...
 
static bool isLocal (const Scope type)
 Returns whether this is local scope. More...
 

Detailed Description

Enumerated type for region distribution scope.

For Native Clients: LOCAL scope is invalid (it is a non-native client local region), and DISTRIBUTED_ACK and DISTRIBUTED_NO_ACK have the same behavior.

See also
RegionAttributes::getScope
AttributesFactory::setScope

Member Enumeration Documentation

Values for setting Scope.

Enumerator
LOCAL 

no distribution.

DISTRIBUTED_NO_ACK 

Distribute without waiting for acknowledgement.

DISTRIBUTED_ACK 

Distribute and wait for all peers to acknowledge.

GLOBAL 

Distribute with full interprocess synchronization – not yet implemented.

Member Function Documentation

static Scope gemfire::ScopeType::fromName ( const char *  name)
static

Returns the type of the Scope represented by name.

static const char* gemfire::ScopeType::fromOrdinal ( const uint8_t  ordinal)
static

Returns the Name of the Scope represented by specified ordinal.

static bool gemfire::ScopeType::isAck ( const Scope  type)
inlinestatic

Returns whether acknowledgements are required for this scope.

Returns
true if this is DISTRIBUTED_ACK or GLOBAL, false otherwise
static bool gemfire::ScopeType::isDistributed ( const Scope  type)
inlinestatic

Returns whether this is one of the distributed scopes.

Returns
true if this is any scope other than LOCAL
static bool gemfire::ScopeType::isDistributedAck ( const Scope  type)
inlinestatic

Returns whether this is distributed ack scope.

Returns
true if this is DISTRIBUTED_ACK
static bool gemfire::ScopeType::isDistributedNoAck ( const Scope  type)
inlinestatic

Returns whether this is distributed no ack scope.

Returns
true if this is DISTRIBUTED_NO_ACK
static bool gemfire::ScopeType::isGlobal ( const Scope  type)
inlinestatic

Returns whether this is global scope.

Returns
true if this is GLOBAL
static bool gemfire::ScopeType::isLocal ( const Scope  type)
inlinestatic

Returns whether this is local scope.

Returns
true if this is LOCAL

GemFire C++ Cache API Documentation