Package akka.coordination.lease.internal
Class LeaseAdapterToScala
- java.lang.Object
-
- akka.coordination.lease.scaladsl.Lease
-
- akka.coordination.lease.internal.LeaseAdapterToScala
-
public final class LeaseAdapterToScala extends Lease
INTERNAL API
-
-
Constructor Summary
Constructors Constructor Description LeaseAdapterToScala(Lease delegate, scala.concurrent.ExecutionContext ec)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description scala.concurrent.Future<java.lang.Object>
acquire()
Try to acquire the lease.scala.concurrent.Future<java.lang.Object>
acquire(scala.Function1<scala.Option<java.lang.Throwable>,scala.runtime.BoxedUnit> leaseLostCallback)
Same as acquire with an additional callback that is called if the lease is lost.boolean
checkLease()
Check if the owner still holds the lease.Lease
delegate()
scala.concurrent.ExecutionContext
ec()
scala.concurrent.Future<java.lang.Object>
release()
Release the lease so some other owner can acquire it.
-
-
-
Constructor Detail
-
LeaseAdapterToScala
public LeaseAdapterToScala(Lease delegate, scala.concurrent.ExecutionContext ec)
-
-
Method Detail
-
acquire
public scala.concurrent.Future<java.lang.Object> acquire()
Description copied from class:Lease
Try to acquire the lease. The returnedFuture
will be completed withtrue
if the lease could be acquired, i.e. no other owner is holding the lease.The returned
Future
will be completed withfalse
if the lease for certain couldn't be acquired, e.g. because some other owner is holding it. It's completed withLeaseException
failure if it might not have been able to acquire the lease, e.g. communication timeout with the lease resource.The lease will be held by the
akka.coordination.lease.LeaseSettings.ownerName
until it is released withLease.release
. A Lease implementation will typically also lose the ownership if it can't maintain its authority, e.g. if it crashes or is partitioned from the lease resource for too long.Lease.checkLease
can be used to verify that the owner still has the lease.
-
acquire
public scala.concurrent.Future<java.lang.Object> acquire(scala.Function1<scala.Option<java.lang.Throwable>,scala.runtime.BoxedUnit> leaseLostCallback)
Description copied from class:Lease
Same as acquire with an additional callback that is called if the lease is lost. The lease can be lose due to being unable to communicate with the lease provider. Implementations should not call leaseLostCallback until after the returned future has been completed
-
checkLease
public boolean checkLease()
Description copied from class:Lease
Check if the owner still holds the lease.true
means that it certainly holds the lease.false
means that it might not hold the lease, but it could, and for more certain response you would have to use {@link Lease#acquire()*} orLease.release()
.- Specified by:
checkLease
in classLease
-
delegate
public Lease delegate()
-
ec
public scala.concurrent.ExecutionContext ec()
-
-