net.openhft.chronicle.queue.impl.table

Class AbstractTSQueueLock

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.queue.impl.table.AbstractTSQueueLock

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

Direct Known Subclasses:

TableStoreWriteLock, TSQueueLock

public abstract class AbstractTSQueueLock
extends net.openhft.chronicle.core.io.AbstractCloseable
implements net.openhft.chronicle.core.io.Closeable

Implements a lock using LongValue and primitives such as CAS.

WARNING: the default behaviour (see also queue.dont.recover.lock.timeout system property) is for a timed-out lock to be overridden.

Field Summary

Fields

Modifier and Type	Field and Description
protected UnlockMode	forceUnlockOnTimeoutWhen
protected net.openhft.chronicle.core.values.LongValue	lock
protected File	path
protected ThreadLocal<net.openhft.chronicle.threads.TimingPauser>	pauser
protected static long	PID
protected TableStore	tableStore
protected static String	UNLOCK_MAIN_MSG
static long	UNLOCKED
protected static String	UNLOCKING_FORCIBLY_MSG

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
AbstractTSQueueLock(String lockKey, TableStore<?> tableStore, Supplier<net.openhft.chronicle.threads.TimingPauser> pauserSupplier)

Method Summary

Modifier and Type	Method and Description
protected void	forceUnlock(long value) will only force unlock if you give it the correct pid
boolean	forceUnlockIfProcessIsDead() forces an unlock only if the process that currently holds the table store lock is no-longer running
boolean	isLockedByCurrentProcess(LongConsumer notCurrentProcessConsumer)
long	lockedBy()
protected void	performClose()
String	toString()

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceName, temporary

Field Detail

UNLOCK_MAIN_MSG

protected static final String UNLOCK_MAIN_MSG

See Also:

Constant Field Values

UNLOCKING_FORCIBLY_MSG

protected static final String UNLOCKING_FORCIBLY_MSG

See Also:

Constant Field Values

PID

protected static final long PID

UNLOCKED

public static final long UNLOCKED

See Also:

Constant Field Values

forceUnlockOnTimeoutWhen

protected final UnlockMode forceUnlockOnTimeoutWhen

lock

protected final net.openhft.chronicle.core.values.LongValue lock

pauser

protected final ThreadLocal<net.openhft.chronicle.threads.TimingPauser> pauser

path

protected final File path

tableStore

protected final TableStore tableStore

Constructor Detail

AbstractTSQueueLock

public AbstractTSQueueLock(String lockKey,
                           TableStore<?> tableStore,
                           Supplier<net.openhft.chronicle.threads.TimingPauser> pauserSupplier)

Method Detail

performClose

protected void performClose()

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

forceUnlock

protected void forceUnlock(long value)

will only force unlock if you give it the correct pid

isLockedByCurrentProcess

public boolean isLockedByCurrentProcess(LongConsumer notCurrentProcessConsumer)

forceUnlockIfProcessIsDead

public boolean forceUnlockIfProcessIsDead()

forces an unlock only if the process that currently holds the table store lock is no-longer running

Returns:

true if the lock was already unlocked, It will not release the lock if it is held by this process or the process that was holding the lock is no longer running (and we were able to unlock). Otherwise false is returned if the lock is held by this process or another live process.

lockedBy

public long lockedBy()

Returns:

the pid that had the locked or the returns UNLOCKED if it is not locked

toString

public String toString()

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable