org.gridgain.grid.kernal.processors.offheap

Class GridOffHeapProcessor

java.lang.Object

org.gridgain.grid.kernal.processors.GridProcessorAdapter

org.gridgain.grid.kernal.processors.offheap.GridOffHeapProcessor

All Implemented Interfaces:

GridComponent, GridProcessor

public class GridOffHeapProcessor
extends GridProcessorAdapter

Manages offheap memory caches.

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.GridProcessorAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridOffHeapProcessor(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
long	allocatedSize(String spaceName) Gets size of a memory allocated for the entries of the given space.
boolean	contains(String spaceName, int part, Object key, byte[] keyBytes) Checks if offheap space contains value for the given key.
void	create(String spaceName, int parts, long init, long max, GridOffHeapEvictListener lsnr) Creates offheap map for given space name.
long	entriesCount(String spaceName) Gets number of elements in the given space.
byte[]	get(String spaceName, int part, Object key, byte[] keyBytes) Gets value bytes from offheap space for the given key.
<T> T	getValue(String spaceName, int part, Object key, byte[] keyBytes, ClassLoader ldr) Gets value from offheap space for the given key.
GridCloseableIterator<GridBiTuple<byte[],byte[]>>	iterator(String spaceName) Gets iterator over contents of the given space.
GridCloseableIterator<GridBiTuple<byte[],byte[]>>	iterator(String spaceName, int part) Gets iterator over contents of partition.
void	put(String spaceName, int part, Object key, byte[] keyBytes, byte[] valBytes) Puts the given value to offheap space for the given key.
byte[]	remove(String spaceName, int part, Object key, byte[] keyBytes) Removes value from offheap space for the given key.
boolean	removex(String spaceName, int part, Object key, byte[] keyBytes) Removes value from offheap space for the given key.
void	stop(boolean cancel) Stops grid component.

Methods inherited from class org.gridgain.grid.kernal.processors.GridProcessorAdapter

addAttributes, assertParameter, collectDiscoveryData, onDiscoveryDataReceived, onKernalStart, onKernalStop, printMemoryStats, start, toString, validateNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GridOffHeapProcessor

public GridOffHeapProcessor(GridKernalContext ctx)

Parameters:

ctx - Kernal context.

Method Detail

create

public void create(@Nullable
          String spaceName,
          int parts,
          long init,
          long max,
          @Nullable
          GridOffHeapEvictListener lsnr)

Creates offheap map for given space name. Previous one will be destructed if it exists.

Parameters:

spaceName - Space name.

parts - Partitions number.

init - Initial size.

max - Maximum size.

lsnr - Eviction listener.

stop

public void stop(boolean cancel)
          throws GridException

Stops grid component.

Specified by:

stop in interface GridComponent

Overrides:

stop in class GridProcessorAdapter

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

GridException - Thrown in case of any errors.

contains

public boolean contains(@Nullable
               String spaceName,
               int part,
               Object key,
               byte[] keyBytes)
                 throws GridException

Checks if offheap space contains value for the given key.

Parameters:

spaceName - Space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

Returns:

true If offheap space contains value for the given key.

Throws:

GridException - If failed.

get

@Nullable
public byte[] get(@Nullable
                  String spaceName,
                  int part,
                  Object key,
                  byte[] keyBytes)
           throws GridException

Gets value bytes from offheap space for the given key.

Parameters:

spaceName - Space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

Returns:

Value bytes.

Throws:

GridException - If failed.

getValue

@Nullable
public <T> T getValue(@Nullable
                      String spaceName,
                      int part,
                      Object key,
                      byte[] keyBytes,
                      @Nullable
                      ClassLoader ldr)
           throws GridException

Gets value from offheap space for the given key.

Parameters:

spaceName - Space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

ldr - Class loader.

Returns:

Value bytes.

Throws:

GridException - If failed.

remove

@Nullable
public byte[] remove(@Nullable
                     String spaceName,
                     int part,
                     Object key,
                     byte[] keyBytes)
              throws GridException

Removes value from offheap space for the given key.

Parameters:

spaceName - Space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

Returns:

Value bytes.

Throws:

GridException - If failed.

put

public void put(@Nullable
       String spaceName,
       int part,
       Object key,
       byte[] keyBytes,
       byte[] valBytes)
         throws GridException

Puts the given value to offheap space for the given key.

Parameters:

spaceName - Space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

valBytes - Value bytes.

Throws:

GridException - If failed.

removex

public boolean removex(@Nullable
              String spaceName,
              int part,
              Object key,
              byte[] keyBytes)
                throws GridException

Removes value from offheap space for the given key.

Parameters:

spaceName - Space name.

part - Partition.

key - Key.

keyBytes - Key bytes.

Returns:

true If succeeded.

Throws:

GridException - If failed.

iterator

public GridCloseableIterator<GridBiTuple<byte[],byte[]>> iterator(@Nullable
                                                         String spaceName)

Gets iterator over contents of the given space.

Parameters:

spaceName - Space name.

Returns:

Iterator.

entriesCount

public long entriesCount(@Nullable
                String spaceName)

Gets number of elements in the given space.

Parameters:

spaceName - Space name. Optional.

Returns:

Number of elements or -1 if no space with the given name has been found.

allocatedSize

public long allocatedSize(@Nullable
                 String spaceName)

Gets size of a memory allocated for the entries of the given space.

Parameters:

spaceName - Space name. Optional.

Returns:

Allocated memory size or -1 if no space with the given name has been found.

iterator

public GridCloseableIterator<GridBiTuple<byte[],byte[]>> iterator(@Nullable
                                                         String spaceName,
                                                         int part)

Gets iterator over contents of partition.

Parameters:

spaceName - Space name.

part - Partition.

Returns:

Iterator.