abstract class Lease extends AnyRef
- Alphabetic
- By Inheritance
- Lease
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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
Future
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 with pekko.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 pekko.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.
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 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Lease toStringFormat[Lease] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Lease, B)
- Implicit
- This member is added by an implicit conversion from Lease toArrowAssoc[Lease] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.