geode-client-native/src/cppcache/ExpirationAction.hpp

#ifndef __GEMFIRE_EXPIRATIONACTION_H__
#define __GEMFIRE_EXPIRATIONACTION_H__
/*=========================================================================
 * Copyright (c) 2002-2014 Pivotal Software, Inc. All Rights Reserved.
 * This product is protected by U.S. and international copyright
 * and intellectual property laws. Pivotal products are covered by
 * more patents listed at http://www.pivotal.io/patents.
 *========================================================================
 */

#include "gfcpp_globals.hpp"

/**
 * @file
 */

namespace gemfire {
/**
 * @class ExpirationAction ExpirationAction.hpp
 * Enumerated type for expiration actions.
 * 
 * @see ExpirationAttributes
 */
class CPPCACHE_EXPORT ExpirationAction {
     //public static methods
 public:
     // types of action

   typedef enum { 
    /** When the region or cached object expires, it is invalidated. */
     INVALIDATE = 0,
    /** When expired, invalidated locally only. */
     LOCAL_INVALIDATE,
    
    /** When the region or cached object expires, it is destroyed. */
     DESTROY,
    /** When expired, destroyed locally only. */
     LOCAL_DESTROY,

    /** invalid type. */
     INVALID_ACTION } Action;
    
     /** 
     * @param name the name of the expiration action
     */
    static Action fromName(const char* name) ;
    
    /**
     * Returns whether this is the action for distributed invalidate.
     * @return true if this in INVALIDATE
     */
    inline static bool isInvalidate(const Action type) 
    {
        return (type==INVALIDATE);
    }
    
    /**
     * Returns whether this is the action for local invalidate.
     * @return true if this is LOCAL_INVALIDATE
     */
    inline static bool isLocalInvalidate(const Action type) 
    {
        return (type==LOCAL_INVALIDATE);
    }
    
    /** Returns whether this is the action for distributed destroy.
     * @return true if this is DESTROY
     */
    inline static bool isDestroy(const Action type) 
    {
        return (type==DESTROY);
    }
    
    /** Returns whether this is the action for local destroy.
     * @return true if thisis LOCAL_DESTROY
     */
    inline static bool isLocalDestroy(const Action type)
    {
        return (type==LOCAL_DESTROY);
    }
    
    /** Returns whether this action is local.
     * @return true if this is LOCAL_INVALIDATE or LOCAL_DESTROY
     */
    inline static bool isLocal(const Action type)
    {
        return (type == LOCAL_INVALIDATE) || (type==LOCAL_DESTROY);
    }
    
    /** Returns whether this action is distributed.
     * @return true if this is INVALIDATE or DESTROY
     */
    inline static bool isDistributed(const Action type) 
    {
        return (type == INVALIDATE) || (type==DESTROY);
    }
        
    /** Return the ExpirationAction represented by the specified ordinal */
    static const char*  fromOrdinal(const int ordinal) ;

    private:
    ExpirationAction();
    ~ExpirationAction();
    static  char*  names[] ; 
};
}; //namespace gemfire
#endif //ifndef __GEMFIRE_EXPIRATIONACTION_H__