cppcache/src/TombstoneExpiryHandler.hpp

/*
 * 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.
 */

#pragma once

#ifndef GEODE_TOMBSTONEEXPIRYHANDLER_H_
#define GEODE_TOMBSTONEEXPIRYHANDLER_H_

#include <geode/ExpirationAction.hpp>
#include <geode/Region.hpp>
#include <geode/internal/geode_globals.hpp>

#include "RegionInternal.hpp"
#include "TombstoneList.hpp"

namespace apache {
namespace geode {
namespace client {

/**
 * @class TombstoneExpiryHandler TombstoneExpiryHandler.hpp
 *
 * The task object which contains the handler which gets triggered
 * when a tombstone expires.
 *
 */
class APACHE_GEODE_EXPORT TombstoneExpiryHandler : public ACE_Event_Handler {
 public:
  TombstoneExpiryHandler(std::shared_ptr<TombstoneEntry> entryPtr,
                         TombstoneList* tombstoneList,
                         std::chrono::milliseconds duration,
                         CacheImpl* cacheImpl);

  int handle_timeout(const ACE_Time_Value& current_time,
                     const void* arg) override;

  int handle_close(ACE_HANDLE handle, ACE_Reactor_Mask close_mask) override;

  void setTombstoneEntry(std::shared_ptr<TombstoneEntry> entryPtr) {
    m_entryPtr = entryPtr;
  }

 private:
  // The entry contained in the tombstone list
  std::shared_ptr<TombstoneEntry> m_entryPtr;
  // Duration after which the task should be reset in case of
  // modification.
  std::chrono::milliseconds m_duration;
  CacheImpl* m_cacheImpl;
  // perform the actual expiration action
  void DoTheExpirationAction(const std::shared_ptr<CacheableKey>& key);

  TombstoneList* m_tombstoneList;
};
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_TOMBSTONEEXPIRYHANDLER_H_