com.hazelcast.spi.hotrestart.impl

Class ConcurrentHotRestartStore

java.lang.Object

com.hazelcast.spi.hotrestart.impl.ConcurrentHotRestartStore

All Implemented Interfaces:

HotRestartStore

public final class ConcurrentHotRestartStore
extends Object
implements HotRestartStore

Concurrent implementation of HotRestartStore which delegates work to a single-threaded HotRestartPersistenceEngine over a many-to-one concurrent queue.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MUTATOR_QUEUE_CAPACITY Capacity of the many-to-one queue used by partition threads to submit to HotRestart persistence thread

Fields inherited from interface com.hazelcast.spi.hotrestart.HotRestartStore

LOG_CATEGORY

Method Summary

Modifier and Type	Method and Description
void	backup(File targetDir) Copies the contents of this hot restart store to the target directory.
void	clear(boolean needsFsync, long... keyPrefixes) Removes all mappings for the supplied list of key prefixes.
void	close() Closes this Hot Restart store and releases any system resources it had acquired.
com.hazelcast.hotrestart.BackupTaskState	getBackupTaskState() Returns the state of the hot restart backup task
DiContainer	getDi() Gives access to the internal DI container, exclusively for testing purposes.
void	hotRestart(boolean failIfAnyData, int storeCount, com.hazelcast.internal.util.concurrent.ConcurrentConveyor<RestartItem>[] keyConveyors, com.hazelcast.internal.util.concurrent.ConcurrentConveyor<RestartItem> keyHandleConveyor, com.hazelcast.internal.util.concurrent.ConcurrentConveyor<RestartItem>[] valueConveyors) Performs hot restart: reads the data from persistent storage and pushes it to its associated RamStoreRegistry.
void	interruptBackupTask() Interrupts the backup task if one is currently running.
String	name() Returns the store's name, which matches the name of its home directory.
void	put(HotRestartKey key, byte[] value, boolean needsFsync) Establishes a persistent mapping from the supplied key to the supplied value.
void	remove(HotRestartKey key, boolean needsFsync) Removes the persistent mapping for the supplied key.

Methods inherited from class java.lang.Object

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

Field Detail

MUTATOR_QUEUE_CAPACITY

public static final int MUTATOR_QUEUE_CAPACITY

Capacity of the many-to-one queue used by partition threads to submit to HotRestart persistence thread

See Also:

Constant Field Values

Method Detail

hotRestart

public void hotRestart(boolean failIfAnyData,
                       int storeCount,
                       com.hazelcast.internal.util.concurrent.ConcurrentConveyor<RestartItem>[] keyConveyors,
                       com.hazelcast.internal.util.concurrent.ConcurrentConveyor<RestartItem> keyHandleConveyor,
                       com.hazelcast.internal.util.concurrent.ConcurrentConveyor<RestartItem>[] valueConveyors)
                throws InterruptedException

Description copied from interface: HotRestartStore

Performs hot restart: reads the data from persistent storage and pushes it to its associated RamStoreRegistry.

Specified by:

hotRestart in interface HotRestartStore

Parameters:

failIfAnyData - if true, the call will fail if any persistent data is found

storeCount - the number of Hot Restart stores associated with the Hazelcast instance

keyConveyors - convey keys from HotRestartStore to RamStore

keyHandleConveyor - conveys key handles from RamStore to HotRestartStore

valueConveyors - convey values from HotRestartStore to RamStore

Throws:

InterruptedException

put

public void put(HotRestartKey key,
                byte[] value,
                boolean needsFsync)

Description copied from interface: HotRestartStore

Establishes a persistent mapping from the supplied key to the supplied value.

This method must not be called while holding a lock that can block the progress of RamStore.copyEntry(KeyHandle, int, RecordDataSink) on any RamStore which can be returned by the RamStoreRegistry associated with this Hot Restart store.

Specified by:

put in interface HotRestartStore

needsFsync - if true, the currently active chunk will be fsync'd before closing. If this parameter is false, there is no guarantee that a later call to #fsync() will make this operation persistent.

remove

public void remove(HotRestartKey key,
                   boolean needsFsync)

Description copied from interface: HotRestartStore

Removes the persistent mapping for the supplied key.

This method must not be called while holding a lock that can block the progress of RamStore.copyEntry(KeyHandle, int, RecordDataSink) on any RamStore which can be returned by the RamStoreRegistry associated with this Hot Restart store.

Specified by:

remove in interface HotRestartStore

needsFsync - if true, the currently active chunk will be fsync'd before closing. If this parameter is false, there is no guarantee that a later call to #fsync() will make this operation persistent.

clear

public void clear(boolean needsFsync,
                  long... keyPrefixes)
           throws HotRestartException

Description copied from interface: HotRestartStore

Removes all mappings for the supplied list of key prefixes.

This method must not be called while holding a lock that can block the progress of RamStore.copyEntry(KeyHandle, int, RecordDataSink) on any RamStore which can be returned by the RamStoreRegistry associated with this Hot Restart store.

Specified by:

clear in interface HotRestartStore

Parameters:

needsFsync - has no effect on the semantics of persistence, but its value must match the "needs fsync" configuration of all supplied key prefixes

keyPrefixes - the key prefixes whose data is to be cleared

Throws:

HotRestartException

close

public void close()
           throws HotRestartException

Description copied from interface: HotRestartStore

Closes this Hot Restart store and releases any system resources it had acquired. The store will permit no further operations on it.

This method must not be called while holding a lock that can block the progress of RamStore.copyEntry(KeyHandle, int, RecordDataSink) on any RamStore which can be returned by the RamStoreRegistry associated with this Hot Restart store.

Specified by:

close in interface HotRestartStore

Throws:

HotRestartException

backup

public void backup(File targetDir)

Description copied from interface: HotRestartStore

Copies the contents of this hot restart store to the target directory. This method will return as soon as copying has started. Further copying will be done after this method has returned.

Specified by:

backup in interface HotRestartStore

Parameters:

targetDir - the directory under which backups for the stores will be created

getBackupTaskState

public com.hazelcast.hotrestart.BackupTaskState getBackupTaskState()

Description copied from interface: HotRestartStore

Returns the state of the hot restart backup task

Specified by:

getBackupTaskState in interface HotRestartStore

interruptBackupTask

public void interruptBackupTask()

Description copied from interface: HotRestartStore

Interrupts the backup task if one is currently running. The contents of the target backup directory will be left as-is

Specified by:

interruptBackupTask in interface HotRestartStore

name

public String name()

Description copied from interface: HotRestartStore

Returns the store's name, which matches the name of its home directory.

Specified by:

name in interface HotRestartStore

getDi

public DiContainer getDi()

Gives access to the internal DI container, exclusively for testing purposes.