net.openhft.chronicle.queue.impl.single

Class TableStoreWriteLock

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

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

net.openhft.chronicle.queue.impl.single.TableStoreWriteLock

All Implemented Interfaces:

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

public class TableStoreWriteLock
extends AbstractTSQueueLock
implements WriteLock

Implements WriteLock) using memory access primitives - see {@link AbstractTSQueueLock}.

WARNING: the default behaviour (see also {@code 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
static String	APPEND_LOCK_KEY

Fields inherited from class net.openhft.chronicle.queue.impl.table.AbstractTSQueueLock

forceUnlockOnTimeoutWhen, lock, path, pauser, PID, tableStore, UNLOCK_MAIN_MSG, UNLOCKED, UNLOCKING_FORCIBLY_MSG

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

CHECK_THREAD_SAFETY, closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_DISCARD_WARNING, WARN_NS

Fields inherited from interface net.openhft.chronicle.queue.impl.single.WriteLock

NO_OP

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

INIT

Constructor Summary

Constructors

Constructor and Description
TableStoreWriteLock(TableStore<?> tableStore, Supplier<net.openhft.chronicle.threads.TimingPauser> pauser, Long timeoutMs)
TableStoreWriteLock(TableStore<?> tableStore, Supplier<net.openhft.chronicle.threads.TimingPauser> pauser, Long timeoutMs, String lockKey)

Method Summary

Modifier and Type	Method and Description
void	forceUnlock() Don't use this - for internal use only
void	forceUnlockQuietly() Don't use this - for internal use only Does not warn when force unlocked
protected @NotNull String	getLockedBy(long value)
void	lock() Guaranteed to succeed in getting the lock (may involve timeout and recovery) or else throw.
boolean	locked()
void	unlock() May not unlock.

Methods inherited from class net.openhft.chronicle.queue.impl.table.AbstractTSQueueLock

forceUnlock, forceUnlockIfProcessIsDead, isLockedByCurrentProcess, lockedBy, performClose, 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, 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.queue.impl.single.WriteLock

close, forceUnlockIfProcessIsDead, isLockedByCurrentProcess

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

APPEND_LOCK_KEY

public static final String APPEND_LOCK_KEY

See Also:

Constant Field Values

Constructor Detail

TableStoreWriteLock

public TableStoreWriteLock(TableStore<?> tableStore,
                           Supplier<net.openhft.chronicle.threads.TimingPauser> pauser,
                           Long timeoutMs,
                           String lockKey)

TableStoreWriteLock

public TableStoreWriteLock(TableStore<?> tableStore,
                           Supplier<net.openhft.chronicle.threads.TimingPauser> pauser,
                           Long timeoutMs)

Method Detail

lock

public void lock()

Guaranteed to succeed in getting the lock (may involve timeout and recovery) or else throw.

This is not re-entrant i.e. if you lock and try and lock again it will timeout and recover

Specified by:

lock in interface WriteLock

getLockedBy

@NotNull
protected @NotNull String getLockedBy(long value)

unlock

public void unlock()

Description copied from interface: WriteLock

May not unlock. If it does not there will be a log.warn

Specified by:

unlock in interface WriteLock

locked

public boolean locked()

Specified by:

locked in interface WriteLock

forceUnlock

public void forceUnlock()

Don't use this - for internal use only

forceUnlockQuietly

public void forceUnlockQuietly()

Don't use this - for internal use only Does not warn when force unlocked