net.openhft.chronicle.queue.impl.single

Interface WriteLock

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ReadOnlyWriteLock, TableStoreWriteLock

public interface WriteLock
extends Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static WriteLock	NO_OP

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.
default boolean	locked()
void	unlock() May not unlock.

Field Detail

NO_OP

static final WriteLock NO_OP

Method Detail

lock

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

unlock

void unlock()

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

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

locked

default boolean locked()

forceUnlockIfProcessIsDead

boolean forceUnlockIfProcessIsDead()

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

Returns:

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

isLockedByCurrentProcess

boolean isLockedByCurrentProcess(LongConsumer notCurrentProcessConsumer)