geode-core/src/main/java/org/apache/geode/internal/cache/entries/OffHeapRegionEntry.java

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

package org.apache.geode.internal.cache.entries;

import org.apache.geode.internal.cache.RegionEntry;
import org.apache.geode.internal.offheap.Releasable;

/**
 * Any RegionEntry that is stored off heap must implement this interface.
 *
 *
 */
public interface OffHeapRegionEntry extends RegionEntry, Releasable {
  /**
   * OFF_HEAP_FIELD_READER
   *
   */
  long getAddress();

  /**
   * OFF_HEAP_FIELD_WRITER
   *
   * @param expectedAddr OFF_HEAP_ADDRESS
   * @param newAddr OFF_HEAP_ADDRESS
   * @return newAddr OFF_HEAP_ADDRESS
   */
  boolean setAddress(long expectedAddr, long newAddr);
}