class LeaseHealthCheck extends () => Future[Boolean]
Performs a lease health check by attempting to acquire and immediately release a test lease.
Once the first check succeeds, subsequent checks return true without contacting the API. This is a quick connectivity test to verify the lease API is accessible.
Returns true if: - Lease is successfully acquired (true) - Lease cannot be acquired due to conflict (another owner has it, but the API is reachable) (false)
Returns false if: - Any exception occurs (LeaseException, AskTimeoutException, etc.)
- Source
- LeaseHealthCheck.scala
- Since
2.0.0
Linear Supertypes
Type Hierarchy
Ordering
- Alphabetic
- By Inheritance
Inherited
- LeaseHealthCheck
- Function0
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new LeaseHealthCheck(system: ActorSystem, leaseProviderName: String)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toany2stringadd[LeaseHealthCheck] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (LeaseHealthCheck, B)
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toArrowAssoc[LeaseHealthCheck] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(): Future[Boolean]
- Definition Classes
- LeaseHealthCheck → Function0
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def check(): Future[Boolean]
- Annotations
- @nowarn()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def ensuring(cond: (LeaseHealthCheck) => Boolean, msg: => Any): LeaseHealthCheck
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toEnsuring[LeaseHealthCheck] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (LeaseHealthCheck) => Boolean): LeaseHealthCheck
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toEnsuring[LeaseHealthCheck] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): LeaseHealthCheck
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toEnsuring[LeaseHealthCheck] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): LeaseHealthCheck
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toEnsuring[LeaseHealthCheck] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val lease: Lease
- Attributes
- protected
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- Function0 → 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 LeaseHealthCheck toStringFormat[LeaseHealthCheck] 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,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (LeaseHealthCheck, B)
- Implicit
- This member is added by an implicit conversion from LeaseHealthCheck toArrowAssoc[LeaseHealthCheck] 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.