2025.10.23.162540-e1ca777

wisp-lease/wisp.lease/Lease

Lease

interface Lease

A Lease is a cluster-wide time-based lock on a given resource. Leases are retrieved via LeaseManager.requestLease.

It should be assumed that calls to checkHeld, acquire and release could invoke remote calls, so consider usage carefully.

Inheritors

AutoCloseableLease

Types

StateChangeListener

interface StateChangeListener

Properties

abstract val name: String

Functions

abstract fun acquire(): Boolean

Attempts to acquire the lock on the lease. If the lock was not already held and the lock was successfully obtained, listeners should be notified.

abstract fun addListener(listener: Lease.StateChangeListener)

Registers a listener that is called on lease state changes.

abstract fun checkHeld(): Boolean

checkHeldElsewhere

abstract fun checkHeldElsewhere(): Boolean

abstract fun release(): Boolean

Release the lock on the lease. This will return true if released. Note that it will return false if the lease was not held. Listeners should be notified before the lock is released.

abstract fun release(lazy: Boolean): Boolean

Release the lock on the lease, with the option of doing it lazily if possible. This should return false if the lease was not held or if the release is lazy. Listeners should be notified before the lock is released.

abstract fun shouldHold(): Boolean