io.atomix.core.lock

Interface DistributedLock

All Superinterfaces:

DistributedPrimitive, Lock, SyncPrimitive

public interface DistributedLock
extends SyncPrimitive, Lock

Distributed lock primitive.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
AsyncDistributedLock	async() Returns the underlying asynchronous primitive.
boolean	tryLock(Duration timeout) Acquires the lock if it is free within the given waiting time and the current thread has not been interrupted.
default boolean	tryLock(long time, TimeUnit unit)

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

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

lock, lockInterruptibly, newCondition, tryLock, unlock

Method Detail

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)

async

AsyncDistributedLock async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive