org.onosproject.store.service.impl

Class DistributedLock

java.lang.Object

org.onosproject.store.service.impl.DistributedLock

All Implemented Interfaces:

org.onosproject.store.service.Lock

public class DistributedLock
extends Object
implements org.onosproject.store.service.Lock

A distributed lock implementation.

Constructor Summary

Constructors

Constructor and Description
DistributedLock(String path, org.onosproject.store.service.DatabaseService databaseService, org.onosproject.cluster.ClusterService clusterService, DistributedLockManager lockManager)

Method Summary

Modifier and Type	Method and Description
long	epoch()
boolean	extendExpiration(int leaseDurationMillis)
boolean	isLocked()
void	lock(int leaseDurationMillis)
CompletableFuture<Void>	lockAsync(int leaseDurationMillis)
String	path()
boolean	tryLock(int leaseDurationMillis)
boolean	tryLock(int waitTimeMillis, int leaseDurationMillis)
void	unlock()

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedLock

public DistributedLock(String path,
                       org.onosproject.store.service.DatabaseService databaseService,
                       org.onosproject.cluster.ClusterService clusterService,
                       DistributedLockManager lockManager)

Method Detail

path

public String path()

Specified by:

path in interface org.onosproject.store.service.Lock

lock

public void lock(int leaseDurationMillis)
          throws InterruptedException

Specified by:

lock in interface org.onosproject.store.service.Lock

Throws:

InterruptedException

lockAsync

public CompletableFuture<Void> lockAsync(int leaseDurationMillis)

Specified by:

lockAsync in interface org.onosproject.store.service.Lock

tryLock

public boolean tryLock(int leaseDurationMillis)

Specified by:

tryLock in interface org.onosproject.store.service.Lock

tryLock

public boolean tryLock(int waitTimeMillis,
                       int leaseDurationMillis)
                throws InterruptedException

Specified by:

tryLock in interface org.onosproject.store.service.Lock

Throws:

InterruptedException

isLocked

public boolean isLocked()

Specified by:

isLocked in interface org.onosproject.store.service.Lock

epoch

public long epoch()

Specified by:

epoch in interface org.onosproject.store.service.Lock

unlock

public void unlock()

Specified by:

unlock in interface org.onosproject.store.service.Lock

extendExpiration

public boolean extendExpiration(int leaseDurationMillis)

Specified by:

extendExpiration in interface org.onosproject.store.service.Lock