com.gemstone.gemfire.internal.offheap.MemoryBlock Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

The newest version!

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.internal.offheap;

import com.gemstone.gemfire.internal.offheap.SimpleMemoryAllocatorImpl.Chunk;
import com.gemstone.gemfire.internal.offheap.SimpleMemoryAllocatorImpl.ChunkType;

/**
 * Basic size and usage information about an off-heap memory block under
 * inspection. For test validation only.
 * 
 * @author Kirk Lund
 */
public interface MemoryBlock {

  public enum State {
    /** Unused fragment (not used and not in a free list) */
    UNUSED, 
    /** Allocated chunk currently in use */
    ALLOCATED, 
    /** Deallocated chunk currently in a free list */
    DEALLOCATED 
  }
  
  public State getState();
  
  /**
   * Returns the unsafe memory address of the first byte of this block.
   */
  public long getMemoryAddress();
  
  /**
   * Returns the size of this memory block in bytes.
   */
  public int getBlockSize();
  
  /**
   * Returns the next memory block immediately after this one.
   */
  public MemoryBlock getNextBlock();
  
  /**
   * Returns the identifier of which slab contains this block.
   */
  public int getSlabId();
  
  /**
   * Returns the identifier of which free list contains this block.
   */
  public int getFreeListId();
  
  public int getRefCount();
  public String getDataType();
  public ChunkType getChunkType();
  public boolean isSerialized();
  public boolean isCompressed();
  public Object getDataValue();
}