Package com.github.ddth.dlock.impl.inmem

Class InmemDLock

java.lang.Object

com.github.ddth.dlock.impl.AbstractDLock

com.github.ddth.dlock.impl.inmem.InmemDLock

All Implemented Interfaces:

IDLock, AutoCloseable

public class InmemDLock
extends AbstractDLock

In-memory implementation of IDLock.

Since:

0.1.0

Author:

Thanh Nguyen

Field Summary

Fields inherited from interface com.github.ddth.dlock.IDLock

DEFAULT_LOCK_DURATION_MS

Constructor Summary

Constructors

Constructor	Description
InmemDLock(String name)

Method Summary

Modifier and Type	Method	Description
LockResult	lock(int waitWeight, String clientId, long lockDurationMs)	Acquire the lock for clientId for a duration of lockDurationMs.
LockResult	unlock(String clientId)	Release the lock.

Methods inherited from class com.github.ddth.dlock.impl.AbstractDLock

close, destroy, getClientId, getLockProperties, getLockProperty, getName, getTimestampExpiry, init, lock, lock, lock, setClientId, setLockProperties, setName, setTimestampExpiry, toString, updateLockHolder

Methods inherited from class java.lang.Object

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

Constructor Detail

InmemDLock

public InmemDLock(String name)

Method Detail

lock

public LockResult lock(int waitWeight,
                       String clientId,
                       long lockDurationMs)

Acquire the lock for clientId for a duration of lockDurationMs.

Reentrant: lock can be acquired multiple times by the same clientId. Lock's expiry will be extended accordingly.

Parameters:

waitWeight - "fairness": clientId with higher waitWeight value might have higher chance to acquire the lock, negative value means "no fairness"

clientId - within a namespace, only one client is allowed to hold the lock as a given time

Returns:

LockResult.SUCCESSFUL if successful, LockResult.HOLD_BY_ANOTHER_CLIENT if lock is currently hold by another client

unlock

public LockResult unlock(String clientId)

Release the lock.

Parameters:

clientId - within a namespace, only one client is allowed to hold the lock as a given time

Returns:

LockResult.SUCCESSFUL if successful, LockResult.HOLD_BY_ANOTHER_CLIENT if lock is currently hold by another client, LockResult.NOT_FOUND if the lock is not currently hold by any client (not locked before, or already expired)