CacheWriter.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_CACHEWRITER_H_
#define GEODE_CACHEWRITER_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"
#include "geode_types.hpp"

namespace apache {
namespace geode {
namespace client {

class EntryEvent;
class RegionEvent;
class CPPCACHE_EXPORT CacheWriter : public SharedBase {
 public:
  virtual bool beforeUpdate(const EntryEvent& event);

  virtual bool beforeCreate(const EntryEvent& event);

  virtual bool beforeDestroy(const EntryEvent& event);

  /*@brief called before this region is cleared
   * @param event EntryEvent denotes the event object associated with clearing
   * the region
   *
   * @see Region::clear
   */
  virtual bool beforeRegionClear(const RegionEvent& event);

  /*@brief called before this region is destroyed
   * @param event EntryEvent denotes the event object associated with destroying
   * the region
   *
   * @see Region::destroyRegion
   */
  virtual bool beforeRegionDestroy(const RegionEvent& event);

  virtual void close(const RegionPtr& rp);

  virtual ~CacheWriter();

 protected:
  CacheWriter();

 private:
  // never implemented.
  CacheWriter(const CacheWriter& other);
  void operator=(const CacheWriter& other);
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_CACHEWRITER_H_