wisp-lease/wisp.lease/AutoCloseableLease

AutoCloseableLease

class AutoCloseableLease @JvmOverloads constructor(lease: Lease, lazy: Boolean = false) : Lease, AutoCloseable

Converts a lease into an AutoCloseable resource.

Constructors

AutoCloseableLease

@JvmOverloads

constructor(lease: Lease, lazy: Boolean = false)

Properties

name

open override val name: String

Functions

acquire

open override 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.

open override fun acquire(options: AcquireOptions): Boolean

Attempts to acquire the lock on the lease with options. Implementations that do not support the requested options should fail rather than silently falling back to weaker acquire semantics, unless AcquireOptions.unsupportedWaitBehavior allows fallback.

addListener

open override fun addListener(listener: Lease.StateChangeListener)

Registers a listener that is called on lease state changes.

open override fun close()

isHeld

open override fun isHeld(): Boolean

Check if this process owns the lease.

release

open override 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.

open override 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.

shouldHold

open override fun shouldHold(): Boolean

Check if this process should own the lease. For example, if a lease is first-come first-serve, then this process should try to own the lease, whereas a lease that uses consistent hashing should try to own if and only if it is assigned the lease.