Package io.atomix.client.lock

Interface DistributedLock

All Superinterfaces:

DistributedPrimitive, Lock, SyncPrimitive<DistributedLock,AsyncDistributedLock>

public interface DistributedLock
extends SyncPrimitive<DistributedLock,AsyncDistributedLock>, Lock

Field Summary

Fields inherited from interface io.atomix.client.SyncPrimitive

DEFAULT_OPERATION_TIMEOUT

Method Summary

Modifier and Type	Method	Description
AsyncDistributedLock	async()	Returns the underlying asynchronous primitive.
static DistributedLockBuilder	builder(AtomixChannel channel)	Returns a new DistributedLock builder.
boolean	isLocked()	Query whether this lock is locked or not.
default boolean	tryLock(long time, TimeUnit unit)
boolean	tryLock(Duration timeout)	Acquires the lock if it is free within the given waiting time and the current thread has not been interrupted.

Methods inherited from interface io.atomix.client.DistributedPrimitive

name

Methods inherited from interface java.util.concurrent.locks.Lock

lock, lockInterruptibly, newCondition, tryLock, unlock

Methods inherited from interface io.atomix.client.SyncPrimitive

close

Method Details

builder

static DistributedLockBuilder builder(AtomixChannel channel)

Returns a new DistributedLock builder.

Parameters:

channel - the AtomixChannel

Returns:

the DistributedLock builder

tryLock

default boolean tryLock(long time,
 TimeUnit unit)
                 throws InterruptedException

Specified by:

tryLock in interface Lock

Throws:

InterruptedException

tryLock

boolean tryLock(Duration timeout)
         throws InterruptedException

Acquires the lock if it is free within the given waiting time and the current thread has not been interrupted.

Parameters:

timeout - the timeout to wait to acquire the lock

Throws:

InterruptedException - if the current thread is interrupted while acquiring the lock (and interruption of lock acquisition is supported)

isLocked

boolean isLocked()

Query whether this lock is locked or not.

Returns:

true if this lock is locked, false otherwise

async

AsyncDistributedLock async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive<DistributedLock,AsyncDistributedLock>

Returns:

the underlying asynchronous primitive