net.openhft.chronicle.queue.impl.single

Class TSQueueLock

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

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

net.openhft.chronicle.queue.impl.single.TSQueueLock

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.core.io.CloseableTracer, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, QueueLock

public class TSQueueLock
extends AbstractTSQueueLock
implements QueueLock

Implements queue lock via TableStore mechanism.

Field Summary

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

dontRecoverLockTimeout, lock, path, pauser, tableStore, UNLOCKED

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

CHECK_THREAD_SAFETY, WARN_NS

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

INIT

Constructor Summary

Constructors

Constructor and Description
TSQueueLock(TableStore<?> tableStore, Supplier<net.openhft.chronicle.threads.TimingPauser> pauser, long timeoutMs)

Method Summary

Modifier and Type	Method and Description
void	acquireLock() Stores current PID to table store, and any other process trying to acquire lock will wait for chronicle.queue.lock.timeoutMS millis (default is 30000) for the lock to be released, and if it is not after timeout, throws IllegalStateException.
void	quietUnlock() wont report if it was unable to unlock, useful when closing, and you are not sure if you hold the lock in the first place.
void	unlock() Checks if the lock is held by current thread and if so, releases it, removing entry from TableStore and clearing ThreadLocal state, allowing anyone to proceed with ChronicleQueue.acquireAppender().
void	waitForLock() checks if current thread holds lock.

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

forceUnlock, forceUnlockIfProcessIsDead, performClose, threadSafetyCheck

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

assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, enableCloseableTracing, isClosed, isClosing, isInUserThread, performCloseInBackground, referenceId, resetUsedByThread, shouldPerformCloseInBackground, shouldWaitForClosed, throwExceptionIfClosed, throwExceptionIfClosedInSetter, toString, unmonitor, 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, notifyClosing

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

isClosed, isClosing, throwExceptionIfClosed

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

referenceName, temporary

Constructor Detail

TSQueueLock

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

Method Detail

acquireLock

public void acquireLock()

Stores current PID to table store, and any other process trying to acquire lock will wait for chronicle.queue.lock.timeoutMS millis (default is 30000) for the lock to be released, and if it is not after timeout, throws IllegalStateException. Also the locking thread ID is stored in threadLocal field, so that only locking thread is allowed to ChronicleQueue.acquireAppender() while the queue is locked.

Specified by:

acquireLock in interface QueueLock

waitForLock

public void waitForLock()

checks if current thread holds lock. If not, it will wait for four times chronicle.queue.lock.timeoutMS millis for the lock to be released, and if it is not after timeout, throws IllegalStateException.

Specified by:

waitForLock in interface QueueLock

unlock

public void unlock()

Checks if the lock is held by current thread and if so, releases it, removing entry from TableStore and clearing ThreadLocal state, allowing anyone to proceed with ChronicleQueue.acquireAppender().

Specified by:

unlock in interface QueueLock

quietUnlock

public void quietUnlock()

Description copied from interface: QueueLock

wont report if it was unable to unlock, useful when closing, and you are not sure if you hold the lock in the first place.

Specified by:

quietUnlock in interface QueueLock