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

Types

Link copied to clipboard

Properties

Link copied to clipboard
abstract val name: String

Functions

Link copied to clipboard
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.

Link copied to clipboard
abstract fun addListener(listener: Lease.StateChangeListener)

Registers a listener that is called on lease state changes.

Link copied to clipboard
abstract fun checkHeld(): Boolean
Link copied to clipboard
abstract fun checkHeldElsewhere(): Boolean
Link copied to clipboard
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.

Link copied to clipboard
abstract fun shouldHold(): Boolean