com.hazelcast.spi.hotrestart.impl.gc.record

Interface RecordMap

All Superinterfaces:

com.hazelcast.nio.Disposable

All Known Implementing Classes:

RecordMapOffHeap, RecordMapOnHeap

public interface RecordMap
extends com.hazelcast.nio.Disposable

Special-purpose map from KeyHandle to Record, used to hold GC-related metadata about one chunk.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RecordMap.Cursor Cursor over record map's contents.

Method Summary

Modifier and Type	Method and Description
RecordMap.Cursor	cursor()
Record	get(KeyHandle kh) Returns the record mapped by the supplied KeyHandle, if any; otherwise returns null.
Record	putIfAbsent(long prefix, KeyHandle kh, long seq, int size, boolean isTombstone, int additionalInt) If there is no current mapping for kh, establishes a mapping from kh to a record defined by (seq, size, isTombstone, additionalInt) and returns null.
int	size()
SortedBySeqRecordCursor	sortedBySeqCursor(int liveRecordCount, RecordMap[] recordMaps, MutatorCatchup mc) Creates a sorted-by-seq cursor over all live records in the provided record maps.
RecordMap	toStable() Special-purpose method supporting an off-heap memory optimization where during GC the growing chunk's record map is stored using an auxiliary memory allocator that allocates from a different pool than the main one, thus reducing the peak memory demand on the main allocator.

Methods inherited from interface com.hazelcast.nio.Disposable

dispose

Method Detail

putIfAbsent

Record putIfAbsent(long prefix,
                   KeyHandle kh,
                   long seq,
                   int size,
                   boolean isTombstone,
                   int additionalInt)

If there is no current mapping for kh, establishes a mapping from kh to a record defined by (seq, size, isTombstone, additionalInt) and returns null. If a mapping already exists, returns the existing record without updating it.

Warning! The returned instance is valid only up to the next update operation on this map. The caller should generally not retain it.

Parameters:

additionalInt - for a value record, this is its garbage count; for tombstone, it is its position in the chunk file.

get

Record get(KeyHandle kh)

Returns the record mapped by the supplied KeyHandle, if any; otherwise returns null. Warning! The returned instance is valid only up to the next operation on this map, including another get. The caller should generally not retain it.

size

int size()

Returns:

the number of entries in this map.

sortedBySeqCursor

SortedBySeqRecordCursor sortedBySeqCursor(int liveRecordCount,
                                          RecordMap[] recordMaps,
                                          MutatorCatchup mc)

Creates a sorted-by-seq cursor over all live records in the provided record maps. The record maps must be of the same type as this record map.

cursor

RecordMap.Cursor cursor()

toStable

RecordMap toStable()

Special-purpose method supporting an off-heap memory optimization where during GC the growing chunk's record map is stored using an auxiliary memory allocator that allocates from a different pool than the main one, thus reducing the peak memory demand on the main allocator. This method moves the data back to the main allocator.

Returns:

a copy of this record map appropriate to be used inside a StableChunk.