party.iroiro.lock

Interface LockHandle

All Known Implementing Classes:

EmptySink, LockHandle.CancellableHandle

public interface LockHandle

A lock handle (including a Mono to listen to and a canceller function).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LockHandle.CancellableHandle

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Attempts to cancels a lock request
static LockHandle	empty()
static LockHandle	from(Mono<Void> mono, Supplier<Boolean> canceller)
Mono<Void>	mono() Returns a Mono that emits success only after acquiring the lock

Method Detail

empty

static LockHandle empty()

from

static LockHandle from(Mono<Void> mono,
                       Supplier<Boolean> canceller)

cancel

boolean cancel()

Attempts to cancels a lock request

Returns:

true if successfully cancelled
false if you have acquired the lock, probably just raced with the cancel request

mono

Mono<Void> mono()

Returns a Mono that emits success only after acquiring the lock

Returns:

a Mono that emits success only after acquiring the lock