net.openhft.chronicle.queue.impl.single

Class ReadOnlyWriteLock

java.lang.Object

net.openhft.chronicle.queue.impl.single.ReadOnlyWriteLock

All Implemented Interfaces:

Closeable, AutoCloseable, WriteLock

public class ReadOnlyWriteLock
extends Object
implements WriteLock

Field Summary

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

NO_OP

Constructor Summary

Constructors

Constructor and Description
ReadOnlyWriteLock()

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	forceUnlockIfProcessIsDead() Forcibly unlocks only if the process that currently holds the lock is no-longer running.
boolean	isLockedByCurrentProcess(LongConsumer notCurrentProcessConsumer)
void	lock() Guaranteed to succeed in getting the lock (may involve timeout and recovery) or else throw.
void	unlock() May not unlock.

Methods inherited from class java.lang.Object

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

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

locked

Constructor Detail

ReadOnlyWriteLock

public ReadOnlyWriteLock()

Method Detail

lock

public void lock()

Description copied from interface: WriteLock

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

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

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface WriteLock

forceUnlockIfProcessIsDead

public boolean forceUnlockIfProcessIsDead()

Description copied from interface: WriteLock

Forcibly unlocks only if the process that currently holds the lock is no-longer running.

This will leave the lock in following states:

• unlocked
  • if the lock was already unlocked
  • if the lock was held by a dead process
• locked
  • if the lock was held by the current process
  • if the lock was held by another live process

Specified by:

forceUnlockIfProcessIsDead in interface WriteLock

Returns:

true lock was left in an unlocked state, false if the lock was left in a locked state.

isLockedByCurrentProcess

public boolean isLockedByCurrentProcess(LongConsumer notCurrentProcessConsumer)

Specified by:

isLockedByCurrentProcess in interface WriteLock