abstract class Lease extends AnyRef
- Alphabetic
- By Inheritance
- Lease
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Lease(settings: LeaseSettings)
Abstract Value Members
-
abstract
def
acquire(leaseLostCallback: (Option[Throwable]) ⇒ Unit): Future[Boolean]
Same as acquire with an additional callback that is called if the lease is lost.
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
-
abstract
def
acquire(): Future[Boolean]
Try to acquire the lease.
Try to acquire the lease. The returned
Futurewill be completed withtrueif the lease could be acquired, i.e. no other owner is holding the lease.The returned
Futurewill be completed withfalseif the lease for certain couldn't be acquired, e.g. because some other owner is holding it. It's completed with akka.coordination.lease.LeaseException 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 with Lease.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.
-
abstract
def
checkLease(): Boolean
Check if the owner still holds the lease.
Check if the owner still holds the lease.
truemeans that it certainly holds the lease.falsemeans that it might not hold the lease, but it could, and for more certain response you would have to use Lease#acquire()* or Lease#release. -
abstract
def
release(): Future[Boolean]
Release the lease so some other owner can acquire it.
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Lease, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
- def ensuring(cond: (Lease) ⇒ Boolean, msg: ⇒ Any): Lease
- def ensuring(cond: (Lease) ⇒ Boolean): Lease
- def ensuring(cond: Boolean, msg: ⇒ Any): Lease
- def ensuring(cond: Boolean): Lease
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val settings: LeaseSettings
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def →[B](y: B): (Lease, B)