io.atomix.core.lock

Interface AtomicLock

All Superinterfaces:

DistributedPrimitive, SyncPrimitive

public interface AtomicLock
extends SyncPrimitive

Asynchronous lock primitive.

Field Summary

Fields inherited from interface io.atomix.primitive.DistributedPrimitive

DEFAULT_OPERATION_TIMEOUT_MILLIS

Method Summary

Modifier and Type	Method and Description
AsyncAtomicLock	async() Returns the underlying asynchronous primitive.
Version	lock() Acquires the lock, blocking until it's available.
Optional<Version>	tryLock() Attempts to acquire the lock.
Optional<Version>	tryLock(Duration timeout) Attempts to acquire the lock for a specified amount of time.
void	unlock() Unlocks the lock.

Methods inherited from interface io.atomix.primitive.SyncPrimitive

close, delete

Methods inherited from interface io.atomix.primitive.DistributedPrimitive

addStateChangeListener, name, protocol, removeStateChangeListener, type

Method Detail

lock

Version lock()

Acquires the lock, blocking until it's available.

Returns:

the acquired lock version

tryLock

Optional<Version> tryLock()

Attempts to acquire the lock.

Returns:

indicates whether the lock was acquired

tryLock

Optional<Version> tryLock(Duration timeout)

Attempts to acquire the lock for a specified amount of time.

Parameters:

timeout - the timeout after which to give up attempting to acquire the lock

Returns:

indicates whether the lock was acquired

unlock

void unlock()

Unlocks the lock.

async

AsyncAtomicLock async()

Description copied from interface: SyncPrimitive

Returns the underlying asynchronous primitive.

Specified by:

async in interface SyncPrimitive

Returns:

the underlying asynchronous primitive