ExpirationAction.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_EXPIRATIONACTION_H_
#define GEODE_EXPIRATIONACTION_H_

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "geode_globals.hpp"

namespace apache {
namespace geode {
namespace client {
class CPPCACHE_EXPORT ExpirationAction {
  // public static methods
 public:
  // types of action

  typedef enum {
    INVALIDATE = 0,
    LOCAL_INVALIDATE,

    DESTROY,
    LOCAL_DESTROY,

    INVALID_ACTION
  } Action;

  static Action fromName(const char* name);

  inline static bool isInvalidate(const Action type) {
    return (type == INVALIDATE);
  }

  inline static bool isLocalInvalidate(const Action type) {
    return (type == LOCAL_INVALIDATE);
  }

  inline static bool isDestroy(const Action type) { return (type == DESTROY); }

  inline static bool isLocalDestroy(const Action type) {
    return (type == LOCAL_DESTROY);
  }

  inline static bool isLocal(const Action type) {
    return (type == LOCAL_INVALIDATE) || (type == LOCAL_DESTROY);
  }

  inline static bool isDistributed(const Action type) {
    return (type == INVALIDATE) || (type == DESTROY);
  }

  static const char* fromOrdinal(const int ordinal);

 private:
  ExpirationAction();
  ~ExpirationAction();
  static char* names[];
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_EXPIRATIONACTION_H_