net.kuujo.copycat.collections.internal.lock

Class DefaultAsyncLock

java.lang.Object

net.kuujo.copycat.resource.internal.AbstractResource<AsyncLock>

net.kuujo.copycat.collections.internal.lock.DefaultAsyncLock

All Implemented Interfaces:

AsyncLock, Resource<AsyncLock>, Managed<AsyncLock>

public class DefaultAsyncLock
extends AbstractResource<AsyncLock>
implements AsyncLock

Default asynchronous lock implementation.

Author:

Jordan Halterman

Field Summary

Fields inherited from class net.kuujo.copycat.resource.internal.AbstractResource

context, executor, serializer

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncLock(ResourceContext context)

Method Summary

Modifier and Type	Method and Description
protected <T> CompletableFuture<T>	checkOpen(java.util.function.Supplier<CompletableFuture<T>> supplier) If the lock is closed, returning a failed CompletableFuture.
CompletableFuture<Void>	close()
CompletableFuture<Boolean>	lock() Acquires the lock.
CompletableFuture<AsyncLock>	open()
CompletableFuture<Void>	unlock() Releases the lock.

Methods inherited from class net.kuujo.copycat.resource.internal.AbstractResource

addShutdownTask, addStartupTask, cluster, isClosed, isOpen, name, runShutdownTasks, runStartupTasks

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.kuujo.copycat.collections.AsyncLock

create, create, create

Methods inherited from interface net.kuujo.copycat.resource.Resource

addShutdownTask, addStartupTask, cluster, name

Methods inherited from interface net.kuujo.copycat.util.Managed

isClosed, isOpen

Constructor Detail

DefaultAsyncLock

public DefaultAsyncLock(ResourceContext context)

Method Detail

checkOpen

protected <T> CompletableFuture<T> checkOpen(java.util.function.Supplier<CompletableFuture<T>> supplier)

If the lock is closed, returning a failed CompletableFuture. Otherwise, calls the given supplier to return the completed future result.

Type Parameters:

T - The future result type.

Parameters:

supplier - The supplier to call if the lock is open.

Returns:

A completable future that if this lock is closed is immediately failed.

lock

public CompletableFuture<Boolean> lock()

Description copied from interface: AsyncLock

Acquires the lock.

Specified by:

lock in interface AsyncLock

Returns:

A completable future to be completed once the lock has been acquired.

unlock

public CompletableFuture<Void> unlock()

Description copied from interface: AsyncLock

Releases the lock.

Specified by:

unlock in interface AsyncLock

Returns:

A completable future to be completed once the lock has been released.

open

public CompletableFuture<AsyncLock> open()

Specified by:

open in interface Managed<AsyncLock>

close

public CompletableFuture<Void> close()

Specified by:

close in interface Managed<AsyncLock>