org.onosproject.store.service.impl

Class DistributedLockManager

java.lang.Object

org.onosproject.store.service.impl.DistributedLockManager

All Implemented Interfaces:

org.onosproject.store.service.LockService

@Service
public class DistributedLockManager
extends Object
implements org.onosproject.store.service.LockService

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEAD_LOCK_TIMEOUT_MS
static String	ONOS_LOCK_TABLE_NAME

Constructor Summary

Constructors

Constructor and Description
DistributedLockManager()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addListener(org.onosproject.store.service.LockEventListener listener)
org.onosproject.store.service.Lock	create(String path)
void	deactivate()
protected CompletableFuture<Void>	lockIfAvailable(org.onosproject.store.service.Lock lock, int leaseDurationMillis) Attempts to acquire the lock as soon as it becomes available.
protected CompletableFuture<Void>	lockIfAvailable(org.onosproject.store.service.Lock lock, int waitTimeMillis, int leaseDurationMillis) Attempts to acquire the lock as soon as it becomes available.
void	removeListener(org.onosproject.store.service.LockEventListener listener)

Methods inherited from class java.lang.Object

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

Field Detail

ONOS_LOCK_TABLE_NAME

public static final String ONOS_LOCK_TABLE_NAME

See Also:

Constant Field Values

DEAD_LOCK_TIMEOUT_MS

public static final int DEAD_LOCK_TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

DistributedLockManager

public DistributedLockManager()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

create

public org.onosproject.store.service.Lock create(String path)

Specified by:

create in interface org.onosproject.store.service.LockService

addListener

public void addListener(org.onosproject.store.service.LockEventListener listener)

Specified by:

addListener in interface org.onosproject.store.service.LockService

removeListener

public void removeListener(org.onosproject.store.service.LockEventListener listener)

Specified by:

removeListener in interface org.onosproject.store.service.LockService

lockIfAvailable

protected CompletableFuture<Void> lockIfAvailable(org.onosproject.store.service.Lock lock,
                                                  int waitTimeMillis,
                                                  int leaseDurationMillis)

Attempts to acquire the lock as soon as it becomes available.

Parameters:

lock - lock to acquire.

waitTimeMillis - maximum time to wait before giving up.

leaseDurationMillis - the duration for which to acquire the lock initially.

Returns:

Future that can be blocked on until lock becomes available.

lockIfAvailable

protected CompletableFuture<Void> lockIfAvailable(org.onosproject.store.service.Lock lock,
                                                  int leaseDurationMillis)

Attempts to acquire the lock as soon as it becomes available.

Parameters:

lock - lock to acquire.

leaseDurationMillis - the duration for which to acquire the lock initially.

Returns:

Future lease expiration date.