gemfire::ExpirationAction Class Reference


Detailed Description

Enumerated type for expiration actions.

See also:
ExpirationAttributes

Public Types

enum  Action {
  INVALIDATE = 0, LOCAL_INVALIDATE, DESTROY, LOCAL_DESTROY,
  INVALID_ACTION
}

Static Public Member Functions

static Action fromName (const char *name)
 
Parameters:
name the name of the expiration action

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

Member Enumeration Documentation

enum gemfire::ExpirationAction::Action

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:
name the 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  )  [inline, static]

Returns whether this is the action for distributed destroy.

Returns:
true if this is DESTROY

static bool gemfire::ExpirationAction::isDistributed ( const Action  type  )  [inline, static]

Returns whether this action is distributed.

Returns:
true if this is INVALIDATE or DESTROY

static bool gemfire::ExpirationAction::isInvalidate ( const Action  type  )  [inline, static]

Returns whether this is the action for distributed invalidate.

Returns:
true if this in INVALIDATE

static bool gemfire::ExpirationAction::isLocal ( const Action  type  )  [inline, static]

Returns whether this action is local.

Returns:
true if this is LOCAL_INVALIDATE or LOCAL_DESTROY

static bool gemfire::ExpirationAction::isLocalDestroy ( const Action  type  )  [inline, static]

Returns whether this is the action for local destroy.

Returns:
true if thisis LOCAL_DESTROY

static bool gemfire::ExpirationAction::isLocalInvalidate ( const Action  type  )  [inline, static]

Returns whether this is the action for local invalidate.

Returns:
true if this is LOCAL_INVALIDATE


GemFire C++ Cache API Documentation