com.hazelcast.elastic.tree

Interface OffHeapTreeStore

All Superinterfaces:

Iterable<OffHeapTreeEntry>

All Known Implementing Classes:

RedBlackTreeStore

public interface OffHeapTreeStore
extends Iterable<OffHeapTreeEntry>

Represents abstract API for the OffHeap append-only key value storage

Method Summary

Modifier and Type	Method and Description
void	dispose(boolean releasePayloads) Release of memory (of all keys,values and entries) associated with storage **WARNING** Special attention is required when disposing a tree this way, if NOT empty.
Iterator<OffHeapTreeEntry>	entries()
Iterator<OffHeapTreeEntry>	entries(OffHeapTreeEntry entry)
Iterator<OffHeapTreeEntry>	entries(OffHeapTreeEntry entry, OrderingDirection direction)
Iterator<OffHeapTreeEntry>	entries(OrderingDirection direction)
OffHeapTreeEntry	getEntry(com.hazelcast.internal.serialization.impl.HeapData key) Looking for key equal to blob;
OffHeapTreeEntry	getEntry(MemoryBlock key) Looking for key equal to blob;
OffHeapTreeEntry	getEntry(MemoryBlock key, OffHeapComparator comparator) Looking for key equal to blob using the given comparator; In case if not-found - if createIfNotExists==true - create new key entry; if createIfNotExists==false - don't create new key entry - return null;
OffHeapTreeEntry	put(MemoryBlock key, MemoryBlock value) Looking for key equal to blob; In case if found - append value represented by value to the chain of key's values; In case if not-found - adds new key to the corresponding place in the tree and assign value to this 'new' key;
void	remove(OffHeapTreeEntry entry) Removes the entry from the tree and disposes used space associated with that entry including Key and Value blobs.
OffHeapTreeEntry	searchEntry(MemoryBlock key) Looking for key equal or closest to blob;

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

entries

Iterator<OffHeapTreeEntry> entries()

Returns:

iterate over keys of the store from root in ascending order

entries

Iterator<OffHeapTreeEntry> entries(OrderingDirection direction)

Returns:

iterate over keys of the store from root with the given direction

entries

Iterator<OffHeapTreeEntry> entries(OffHeapTreeEntry entry)

Returns:

iterate over keys of the store from entry

entries

Iterator<OffHeapTreeEntry> entries(OffHeapTreeEntry entry,
                                   OrderingDirection direction)

Returns:

iterate over keys of the store from the entry with the given direction

put

OffHeapTreeEntry put(MemoryBlock key,
                     MemoryBlock value)

Looking for key equal to blob; In case if found - append value represented by value to the chain of key's values;

In case if not-found - adds new key to the corresponding place in the tree and assign value to this 'new' key;

Parameters:

key - - The key blob;

value - - The value blob;

Returns:

The Entry associated with the key;

getEntry

OffHeapTreeEntry getEntry(com.hazelcast.internal.serialization.impl.HeapData key)

Looking for key equal to blob;

Parameters:

key - - The key blob;

Returns:

The Entry associated with the key or null if not found

getEntry

OffHeapTreeEntry getEntry(MemoryBlock key)

Looking for key equal to blob;

Parameters:

key - - The key blob;

Returns:

The Entry associated with the key or null if not found

getEntry

OffHeapTreeEntry getEntry(MemoryBlock key,
                          OffHeapComparator comparator)

Looking for key equal to blob using the given comparator; In case if not-found - if createIfNotExists==true - create new key entry; if createIfNotExists==false - don't create new key entry - return null;

Parameters:

key - - The key blob;

comparator - - comparator to be used, if null default passed in constructor will be used

Returns:

address of the key entry

searchEntry

OffHeapTreeEntry searchEntry(MemoryBlock key)

Looking for key equal or closest to blob;

Parameters:

key - - The key blob;

Returns:

address of the key entry equal od closest to, or zero address if map empty

dispose

void dispose(boolean releasePayloads)

Release of memory (of all keys,values and entries) associated with storage **WARNING** Special attention is required when disposing a tree this way, if NOT empty. When a tree contains duplicate values, either on the same entry or different ones, this can cause the VM to crash when free'ing the same address twice. The safe way is to always dispose the entries one by one, and the key/values should be disposed by their original owner.

remove

void remove(OffHeapTreeEntry entry)

Removes the entry from the tree and disposes used space associated with that entry including Key and Value blobs. All resources associated with the entry will be disposed, however the actual Entry (Key & Value(s)) are assumed to be managed by their owners, therefore no attempt is made to dispose them. To release their resources, first fetch them with getEntry(MemoryBlock) and dispose the allocated chunks on the addresses of the returned Entry Key & Values. Eg.

 OffHeapTreeEntry entry = getEntry(...);
 dispose(entry.getKey());
 for (MemoryBlock value : entry) {
     dispose(value);
 }
 remove(entry);
 

Parameters:

entry - The tree entry to be removed