Package io.github.devlibx.easy.lock

Interface IDistributedLock

All Known Implementing Classes:

IDistributedLockService.NoOpDistributedLock

public interface IDistributedLock

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IDistributedLock.LockRequest	Request to take a lock

Method Summary

Modifier and Type	Method	Description
Lock	achieveLock(IDistributedLock.LockRequest request)	Take a lock
void	releaseLock(Lock lock, IDistributedLock.LockRequest lockRequest)	Release a lock
default void	releaseResources()	Release all resources
default void	setup(LockConfig lockConfig)	Setup a lock
default void	tearDown()	Teardown a lock and release andy resources used

Method Details

setup

default void setup(LockConfig lockConfig)

Setup a lock

tearDown

default void tearDown()

Teardown a lock and release andy resources used

achieveLock

Lock achieveLock(IDistributedLock.LockRequest request)

Take a lock

Returns:

a lock object once lock is taken

releaseLock

void releaseLock(Lock lock,
 IDistributedLock.LockRequest lockRequest)

Release a lock

releaseResources

default void releaseResources()

Release all resources