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

Enumerated type for expiration actions. More...

Public Types

Static Public Member Functions

static Action fromName (const char *name)
 
static const char * fromOrdinal (const int ordinal)
 Return the ExpirationAction represented by the specified ordinal. More...
 
static bool isDestroy (const Action type)
 Returns whether this is the action for distributed destroy. More...
 
static bool isDistributed (const Action type)
 Returns whether this action is distributed. More...
 
static bool isInvalidate (const Action type)
 Returns whether this is the action for distributed invalidate. More...
 
static bool isLocal (const Action type)
 Returns whether this action is local. More...
 
static bool isLocalDestroy (const Action type)
 Returns whether this is the action for local destroy. More...
 
static bool isLocalInvalidate (const Action type)
 Returns whether this is the action for local invalidate. More...
 

Detailed Description

Enumerated type for expiration actions.

See also
ExpirationAttributes

Member Enumeration Documentation

Enumerator
INVALIDATE 

When the region or cached object expires, it is invalidated.

LOCAL_INVALIDATE 

When expired, invalidated locally only.

DESTROY 

When the region or cached object expires, it is destroyed.

LOCAL_DESTROY 

When expired, destroyed locally only.

INVALID_ACTION 

invalid type.

Member Function Documentation

static Action gemfire::ExpirationAction::fromName ( const char *  name)
static
Parameters
namethe name of the expiration action
static const char* gemfire::ExpirationAction::fromOrdinal ( const int  ordinal)
static

Return the ExpirationAction represented by the specified ordinal.

static bool gemfire::ExpirationAction::isDestroy ( const Action  type)
inlinestatic

Returns whether this is the action for distributed destroy.

Returns
true if this is DESTROY
static bool gemfire::ExpirationAction::isDistributed ( const Action  type)
inlinestatic

Returns whether this action is distributed.

Returns
true if this is INVALIDATE or DESTROY
static bool gemfire::ExpirationAction::isInvalidate ( const Action  type)
inlinestatic

Returns whether this is the action for distributed invalidate.

Returns
true if this in INVALIDATE
static bool gemfire::ExpirationAction::isLocal ( const Action  type)
inlinestatic

Returns whether this action is local.

Returns
true if this is LOCAL_INVALIDATE or LOCAL_DESTROY
static bool gemfire::ExpirationAction::isLocalDestroy ( const Action  type)
inlinestatic

Returns whether this is the action for local destroy.

Returns
true if thisis LOCAL_DESTROY
static bool gemfire::ExpirationAction::isLocalInvalidate ( const Action  type)
inlinestatic

Returns whether this is the action for local invalidate.

Returns
true if this is LOCAL_INVALIDATE

GemFire C++ Cache API Documentation