net.kuujo.copycat.collections

Interface AsyncLock

All Superinterfaces:

Managed<AsyncLock>, Resource<AsyncLock>

All Known Implementing Classes:

DefaultAsyncLock

public interface AsyncLock
extends Resource<AsyncLock>

Asynchronous lock.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
static AsyncLock	create(String name) Creates a new asynchronous lock with the default cluster configuration.
static AsyncLock	create(String name, ClusterConfig cluster) Creates a new asynchronous lock.
static AsyncLock	create(String name, ClusterConfig cluster, AsyncLockConfig config) Creates a new asynchronous lock.
CompletableFuture<Boolean>	lock() Acquires the lock.
CompletableFuture<Void>	unlock() Releases the lock.

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

addShutdownTask, addStartupTask, cluster, name

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

close, isClosed, isOpen, open

Method Detail

create

static AsyncLock create(String name)

Creates a new asynchronous lock with the default cluster configuration.

The lock will be constructed with the default cluster configuration. The default cluster configuration searches for two resources on the classpath - cluster and {cluster-defaults} - in that order. Configuration options specified in cluster.conf will override those in {cluster-defaults.conf}.

Additionally, the lock will be constructed with an lock configuration that searches the classpath for three configuration files - {name}, lock, lock-defaults, resource, and resource-defaults - in that order. The first resource is a configuration resource with the same name as the lock resource. If the resource is namespaced - e.g. `locks.my-lock.conf` - then resource configurations will be loaded according to namespaces as well; for example, `locks.conf`.

Parameters:

name - The asynchronous lock name.

Returns:

The asynchronous lock.

create

static AsyncLock create(String name,
                        ClusterConfig cluster)

Creates a new asynchronous lock.

The lock will be constructed with an lock configuration that searches the classpath for three configuration files - {name}, lock, lock-defaults, resource, and resource-defaults - in that order. The first resource is a configuration resource with the same name as the lock resource. If the resource is namespaced - e.g. `locks.my-lock.conf` - then resource configurations will be loaded according to namespaces as well; for example, `locks.conf`.

Parameters:

name - The asynchronous lock name.

cluster - The cluster configuration.

Returns:

The asynchronous lock.

create

static AsyncLock create(String name,
                        ClusterConfig cluster,
                        AsyncLockConfig config)

Creates a new asynchronous lock.

Parameters:

name - The asynchronous lock name.

cluster - The cluster configuration.

config - The lock configuration.

Returns:

The asynchronous lock.

lock

CompletableFuture<Boolean> lock()

Acquires the lock.

Returns:

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

unlock

CompletableFuture<Void> unlock()

Releases the lock.

Returns:

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