Package org.infinispan.container.offheap

Class OffHeapEntryFactoryImpl

java.lang.Object

org.infinispan.container.offheap.OffHeapEntryFactoryImpl

All Implemented Interfaces:

KeyValueMetadataSizeCalculator<org.infinispan.commons.marshall.WrappedBytes,org.infinispan.commons.marshall.WrappedBytes>, OffHeapEntryFactory

public class OffHeapEntryFactoryImpl
extends Object
implements OffHeapEntryFactory

Factory that can create CacheEntry instances from off-heap memory.

Since:

9.0

Author:

wburns

Constructor Summary

Constructors

Constructor	Description
OffHeapEntryFactoryImpl()

Method Summary

Modifier and Type	Method	Description
long	calculateSize(org.infinispan.commons.marshall.WrappedBytes key, org.infinispan.commons.marshall.WrappedBytes value, Metadata metadata, PrivateMetadata internalMetadata)	Method used to calculate how much memory in size the key, value, metadata and internal metadata use.
long	create(org.infinispan.commons.marshall.WrappedBytes key, int hashCode, InternalCacheEntry<org.infinispan.commons.marshall.WrappedBytes,org.infinispan.commons.marshall.WrappedBytes> ice)	Creates an off heap entry using the provided key value and metadata
boolean	equalsKey(long address, org.infinispan.commons.marshall.WrappedBytes wrappedBytes, int hashCode)	Returns whether the given key as bytes is the same key as the key stored in the entry for the given address.
InternalCacheEntry<org.infinispan.commons.marshall.WrappedBytes,org.infinispan.commons.marshall.WrappedBytes>	fromMemory(long address)	Assumes the address doesn't contain the linked pointer at the beginning
int	getHashCode(long entryAddress)	Returns the hashCode of the address.
byte[]	getKey(long address)	Returns the key of the address.
long	getNext(long entryAddress)	Returns the address to the next linked pointer if there is one for this bucket or 0 if there isn't one
long	getSize(long entryAddress, boolean includeAllocationOverhead)	Returns how many bytes in memory this address location uses assuming it is an InternalCacheEntry.
boolean	isExpired(long address)	Returns whether entry is expired.
void	setNext(long entryAddress, long value)	Called to update the next pointer index when a collision occurs requiring a linked list within the entries themselves
void	start()
long	updateMaxIdle(long address, long currentTimeMillis)	Update max idle time for an entry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.container.offheap.OffHeapEntryFactory

calculateSize, equalsKey

Constructor Detail

OffHeapEntryFactoryImpl

public OffHeapEntryFactoryImpl()

Method Detail

start

public void start()

create

public long create(org.infinispan.commons.marshall.WrappedBytes key,
                   int hashCode,
                   InternalCacheEntry<org.infinispan.commons.marshall.WrappedBytes,org.infinispan.commons.marshall.WrappedBytes> ice)

Description copied from interface: OffHeapEntryFactory

Creates an off heap entry using the provided key value and metadata

Specified by:

create in interface OffHeapEntryFactory

Parameters:

key - the key to use

hashCode - the hashCode of the key

ice - the internal entry to use

Returns:

the address of where the entry was created

getSize

public long getSize(long entryAddress,
                    boolean includeAllocationOverhead)

Description copied from interface: OffHeapEntryFactory

Returns how many bytes in memory this address location uses assuming it is an InternalCacheEntry.

Specified by:

getSize in interface OffHeapEntryFactory

Parameters:

entryAddress - the address of the entry

includeAllocationOverhead - if true, align to 8 bytes and add 16 bytes allocation overhead

Returns:

how many bytes this address was estimated to be

getNext

public long getNext(long entryAddress)

Description copied from interface: OffHeapEntryFactory

Returns the address to the next linked pointer if there is one for this bucket or 0 if there isn't one

Specified by:

getNext in interface OffHeapEntryFactory

Parameters:

entryAddress - the address of the entry

Returns:

the next address entry for this bucket or 0

setNext

public void setNext(long entryAddress,
                    long value)

Description copied from interface: OffHeapEntryFactory

Called to update the next pointer index when a collision occurs requiring a linked list within the entries themselves

Specified by:

setNext in interface OffHeapEntryFactory

Parameters:

entryAddress - the address of the entry to update

value - the value of the linked node to set

getHashCode

public int getHashCode(long entryAddress)

Description copied from interface: OffHeapEntryFactory

Returns the hashCode of the address. This

Specified by:

getHashCode in interface OffHeapEntryFactory

Parameters:

entryAddress - the address of the entry

Returns:

the has code of the entry

getKey

public byte[] getKey(long address)

Description copied from interface: OffHeapEntryFactory

Returns the key of the address.

Specified by:

getKey in interface OffHeapEntryFactory

Parameters:

address - the address of the entry

Returns:

the bytes for the key

fromMemory

public InternalCacheEntry<org.infinispan.commons.marshall.WrappedBytes,org.infinispan.commons.marshall.WrappedBytes> fromMemory(long address)

Assumes the address doesn't contain the linked pointer at the beginning

Specified by:

fromMemory in interface OffHeapEntryFactory

Parameters:

address - the address to read the entry from

Returns:

the entry at the memory location

equalsKey

public boolean equalsKey(long address,
                         org.infinispan.commons.marshall.WrappedBytes wrappedBytes,
                         int hashCode)

Description copied from interface: OffHeapEntryFactory

Returns whether the given key as bytes is the same key as the key stored in the entry for the given address.

Specified by:

equalsKey in interface OffHeapEntryFactory

Parameters:

address - the address of the entry's key to check

wrappedBytes - the key to check equality with

hashCode - the hashCode of the key

Returns:

whether or not the keys are equal

isExpired

public boolean isExpired(long address)

Returns whether entry is expired.

Specified by:

isExpired in interface OffHeapEntryFactory

Parameters:

address - the address of the entry to check

Returns:

true if the entry is expired, false otherwise

calculateSize

public long calculateSize(org.infinispan.commons.marshall.WrappedBytes key,
                          org.infinispan.commons.marshall.WrappedBytes value,
                          Metadata metadata,
                          PrivateMetadata internalMetadata)

Description copied from interface: OffHeapEntryFactory

Method used to calculate how much memory in size the key, value, metadata and internal metadata use.

Specified by:

calculateSize in interface KeyValueMetadataSizeCalculator<org.infinispan.commons.marshall.WrappedBytes,org.infinispan.commons.marshall.WrappedBytes>

Specified by:

calculateSize in interface OffHeapEntryFactory

Parameters:

key - The key for this entry to be used in size calculation

value - The value for this entry to be used in size calculation

metadata - The metadata for this entry to be used in size calculation

internalMetadata - The internal metadata for this entry to be used in size calculation

Returns:

The size approximately in memory the key, value and metadata use.

updateMaxIdle

public long updateMaxIdle(long address,
                          long currentTimeMillis)

Description copied from interface: OffHeapEntryFactory

Update max idle time for an entry. This method will try to do an in place update of the access time, however if the new resulting value cannot fit it will allocate a new block of memory. The caller should free the old address in this case.

Specified by:

updateMaxIdle in interface OffHeapEntryFactory

Parameters:

address - the address of the entry's to update

currentTimeMillis - the timestamp to set for max idle access time (must be in milliseconds)

Returns:

address of the new entry to use or 0 if the same one can be reused