com.terracottatech.offheapstore.storage.restartable.partial

Class RestartablePartialStorageEngine<I,K,V>

java.lang.Object

org.terracotta.offheapstore.storage.listener.AbstractListenableStorageEngine<K,V>

com.terracottatech.offheapstore.storage.restartable.partial.RestartableMinimalStorageEngine<I,K,V>

com.terracottatech.offheapstore.storage.restartable.partial.RestartablePartialStorageEngine<I,K,V>

All Implemented Interfaces:

com.terracottatech.frs.object.ObjectManagerSegment<I,ByteBuffer,ByteBuffer>, BinaryStorageEngine, ListenableStorageEngine<K,V>, StorageEngine<K,V>

public class RestartablePartialStorageEngine<I,K,V>
extends RestartableMinimalStorageEngine<I,K,V>

Author:

cdennis

Nested Class Summary

Nested classes/interfaces inherited from class com.terracottatech.offheapstore.storage.restartable.partial.RestartableMinimalStorageEngine

RestartableMinimalStorageEngine.Entry

Nested classes/interfaces inherited from interface org.terracotta.offheapstore.storage.StorageEngine

StorageEngine.Owner

Field Summary

Fields inherited from class com.terracottatech.offheapstore.storage.restartable.partial.RestartableMinimalStorageEngine

keyPortability, metadataArea, owner, valuePortability

Constructor Summary

Constructors

Constructor and Description
RestartablePartialStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int initialPageSize, int maximalPageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
RestartablePartialStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int initialPageSize, int maximalPageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, float compressThreshold)
RestartablePartialStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int pageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
RestartablePartialStorageEngine(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int pageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, float compressThreshold)

Method Summary

Modifier and Type	Method and Description
void	bind(StorageEngine.Owner owner)
void	clear() Called to indicate that all keys and values are now free.
static <I,K,V> Factory<RestartablePartialStorageEngine<I,K,V>>	createPartialFactory(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int initialPageSize, int maximalPageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
static <I,K,V> Factory<RestartablePartialStorageEngine<I,K,V>>	createPartialFactory(I identifier, com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource, boolean synchronous, PointerSize width, PageSource source, int pageSize, Portability<? super K> keyPortability, Portability<? super V> valuePortability, boolean thief, boolean victim, float compressThreshold)
void	destroy()
boolean	equalsBinaryKey(ByteBuffer probeBinaryKey, long encoding)
boolean	equalsKey(Object key, long encoding) Called to determine the equality of the given object against the given encoded form.
boolean	equalsValue(Object value, long encoding) Called to determine the equality of the given Java object value against the given encoded form.
void	freeMapping(long encoding, int hash, boolean removal) Called to indicate that the associated encoded value is no longer needed.
protected int	getActualEntrySize(long encoding)
long	getAllocatedMemory() Returns a measure of the amount of memory allocated for this storage engine.
long	getOccupiedMemory() Returns a measure of the amount of memory consumed by this storage engine.
protected int	getRequiredEntrySize(ByteBuffer binaryKey, ByteBuffer binaryValue)
ByteBuffer	readBinaryKey(long encoding)
ByteBuffer	readBinaryValue(long encoding)
K	readKey(long encoding, int hashcode) Converts the supplied encoded key into its correct object form.
V	readValue(long encoding) Converts the supplied encoded value into its correct object form.
boolean	shrink()
Long	writeBinaryMapping(ByteBuffer[] binaryKey, ByteBuffer[] binaryValue, int pojoHash, int metadata)
Long	writeBinaryMapping(ByteBuffer binaryKey, ByteBuffer binaryValue, int pojoHash, int metadata)
Long	writeMapping(K key, V value, int hash, int metadata) Converts the supplied key and value objects into their encoded form.

Methods inherited from class com.terracottatech.offheapstore.storage.restartable.partial.RestartableMinimalStorageEngine

acquireCompactionEntry, assignLsn, attachedMapping, createMinimalFactory, createMinimalFactory, deriveMetadata, detach, equalsBinaryKey, firstEncoding, getDataSize, getLowestLsn, getLsn, getVitalMemory, invalidateCache, lastEncoding, linkNodeExpectingFirst, linkNodeExpectingLast, put, readEntry, readKeyHash, releaseCompactionEntry, remove, replayPut, size, sizeInBytes, unlinkNode, updateLsn, validChain, writePartialEntry

Methods inherited from class org.terracotta.offheapstore.storage.listener.AbstractListenableStorageEngine

fireCleared, fireCopied, fireFreed, fireRecovered, fireWritten, hasListeners, hasRecoveryListeners, registerListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RestartablePartialStorageEngine

public RestartablePartialStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int pageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       float compressThreshold)

RestartablePartialStorageEngine

public RestartablePartialStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int initialPageSize,
                                       int maximalPageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       float compressThreshold)

RestartablePartialStorageEngine

public RestartablePartialStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int pageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       boolean thief,
                                       boolean victim,
                                       float compressThreshold)

RestartablePartialStorageEngine

public RestartablePartialStorageEngine(I identifier,
                                       com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                       boolean synchronous,
                                       PointerSize width,
                                       PageSource source,
                                       int initialPageSize,
                                       int maximalPageSize,
                                       Portability<? super K> keyPortability,
                                       Portability<? super V> valuePortability,
                                       boolean thief,
                                       boolean victim,
                                       float compressThreshold)

Method Detail

createPartialFactory

public static <I,K,V> Factory<RestartablePartialStorageEngine<I,K,V>> createPartialFactory(I identifier,
                                                                                           com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                                                                           boolean synchronous,
                                                                                           PointerSize width,
                                                                                           PageSource source,
                                                                                           int pageSize,
                                                                                           Portability<? super K> keyPortability,
                                                                                           Portability<? super V> valuePortability,
                                                                                           boolean thief,
                                                                                           boolean victim,
                                                                                           float compressThreshold)

createPartialFactory

public static <I,K,V> Factory<RestartablePartialStorageEngine<I,K,V>> createPartialFactory(I identifier,
                                                                                           com.terracottatech.frs.RestartStore<I,ByteBuffer,ByteBuffer> transactionSource,
                                                                                           boolean synchronous,
                                                                                           PointerSize width,
                                                                                           PageSource source,
                                                                                           int initialPageSize,
                                                                                           int maximalPageSize,
                                                                                           Portability<? super K> keyPortability,
                                                                                           Portability<? super V> valuePortability,
                                                                                           boolean thief,
                                                                                           boolean victim,
                                                                                           float compressThreshold)

writeMapping

public Long writeMapping(K key,
                         V value,
                         int hash,
                         int metadata)

Description copied from interface: StorageEngine

Converts the supplied key and value objects into their encoded form.

Specified by:

writeMapping in interface StorageEngine<K,V>

Overrides:

writeMapping in class RestartableMinimalStorageEngine<I,K,V>

Parameters:

key - a key object

value - a value object

hash - the key hash

metadata - the metadata bits

Returns:

the encoded mapping

writeBinaryMapping

public Long writeBinaryMapping(ByteBuffer binaryKey,
                               ByteBuffer binaryValue,
                               int pojoHash,
                               int metadata)

Specified by:

writeBinaryMapping in interface BinaryStorageEngine

Overrides:

writeBinaryMapping in class RestartableMinimalStorageEngine<I,K,V>

writeBinaryMapping

public Long writeBinaryMapping(ByteBuffer[] binaryKey,
                               ByteBuffer[] binaryValue,
                               int pojoHash,
                               int metadata)

Specified by:

writeBinaryMapping in interface BinaryStorageEngine

Overrides:

writeBinaryMapping in class RestartableMinimalStorageEngine<I,K,V>

getRequiredEntrySize

protected int getRequiredEntrySize(ByteBuffer binaryKey,
                                   ByteBuffer binaryValue)

Overrides:

getRequiredEntrySize in class RestartableMinimalStorageEngine<I,K,V>

getActualEntrySize

protected int getActualEntrySize(long encoding)

Overrides:

getActualEntrySize in class RestartableMinimalStorageEngine<I,K,V>

freeMapping

public void freeMapping(long encoding,
                        int hash,
                        boolean removal)

Description copied from interface: StorageEngine

Called to indicate that the associated encoded value is no longer needed.

This call can be used to free any associated resources tied to the lifecycle of the supplied encoded value.

Specified by:

freeMapping in interface StorageEngine<K,V>

Overrides:

freeMapping in class RestartableMinimalStorageEngine<I,K,V>

Parameters:

encoding - encoded value

hash - hash of the freed mapping

removal - marks removal from a map

readValue

public V readValue(long encoding)

Description copied from interface: StorageEngine

Converts the supplied encoded value into its correct object form.

Specified by:

readValue in interface StorageEngine<K,V>

Overrides:

readValue in class RestartableMinimalStorageEngine<I,K,V>

Parameters:

encoding - encoded value

Returns:

a decoded value object

equalsValue

public boolean equalsValue(Object value,
                           long encoding)

Description copied from interface: StorageEngine

Called to determine the equality of the given Java object value against the given encoded form.

Simple implementations will probably perform a decode on the given encoded form in order to do a regular Object.equals(Object) comparison. This method is provided to allow implementations to optimize this comparison if possible.

Specified by:

equalsValue in interface StorageEngine<K,V>

Overrides:

equalsValue in class RestartableMinimalStorageEngine<I,K,V>

Parameters:

value - a value object

encoding - encoded value

Returns:

true if the value and the encoding are equal

readKey

public K readKey(long encoding,
                 int hashcode)

Description copied from interface: StorageEngine

Converts the supplied encoded key into its correct object form.

Specified by:

readKey in interface StorageEngine<K,V>

Overrides:

readKey in class RestartableMinimalStorageEngine<I,K,V>

Parameters:

encoding - encoded key

hashcode - hash-code of the decoded key

Returns:

a decoded key object

equalsKey

public boolean equalsKey(Object key,
                         long encoding)

Description copied from interface: StorageEngine

Called to determine the equality of the given object against the given encoded form.

Simple implementations will probably perform a decode on the given encoded form in order to do a regular Object.equals(Object) comparison. This method is provided to allow implementations to optimize this comparison if possible.

Specified by:

equalsKey in interface StorageEngine<K,V>

Overrides:

equalsKey in class RestartableMinimalStorageEngine<I,K,V>

Parameters:

key - a key object

encoding - encoded value

Returns:

true if the key and the encoding are equal

equalsBinaryKey

public boolean equalsBinaryKey(ByteBuffer probeBinaryKey,
                               long encoding)

Specified by:

equalsBinaryKey in interface BinaryStorageEngine

Overrides:

equalsBinaryKey in class RestartableMinimalStorageEngine<I,K,V>

clear

public void clear()

Description copied from interface: StorageEngine

Called to indicate that all keys and values are now free.

Specified by:

clear in interface StorageEngine<K,V>

Overrides:

clear in class RestartableMinimalStorageEngine<I,K,V>

getAllocatedMemory

public long getAllocatedMemory()

Description copied from interface: StorageEngine

Returns a measure of the amount of memory allocated for this storage engine.

Specified by:

getAllocatedMemory in interface StorageEngine<K,V>

Overrides:

getAllocatedMemory in class RestartableMinimalStorageEngine<I,K,V>

Returns:

memory allocated for this engine in bytes

getOccupiedMemory

public long getOccupiedMemory()

Description copied from interface: StorageEngine

Returns a measure of the amount of memory consumed by this storage engine.

Specified by:

getOccupiedMemory in interface StorageEngine<K,V>

Overrides:

getOccupiedMemory in class RestartableMinimalStorageEngine<I,K,V>

Returns:

memory occupied by this engine in bytes

bind

public void bind(StorageEngine.Owner owner)

Specified by:

bind in interface StorageEngine<K,V>

Overrides:

bind in class RestartableMinimalStorageEngine<I,K,V>

destroy

public void destroy()

Specified by:

destroy in interface StorageEngine<K,V>

Overrides:

destroy in class RestartableMinimalStorageEngine<I,K,V>

shrink

public boolean shrink()

Specified by:

shrink in interface StorageEngine<K,V>

Overrides:

shrink in class RestartableMinimalStorageEngine<I,K,V>

readBinaryKey

public ByteBuffer readBinaryKey(long encoding)

Specified by:

readBinaryKey in interface BinaryStorageEngine

Overrides:

readBinaryKey in class RestartableMinimalStorageEngine<I,K,V>

readBinaryValue

public ByteBuffer readBinaryValue(long encoding)

Specified by:

readBinaryValue in interface BinaryStorageEngine

Overrides:

readBinaryValue in class RestartableMinimalStorageEngine<I,K,V>