salvus.flow.acta.memo.single_flight
salvus.flow.acta.memo.single_flight salvus flow acta memo single_flight Per-key leases to avoid duplicate task execution.
Recheck the cache after acquiring a lease, commit before releasing it, and renew or release only leases owned by the caller. Expired leases may be acquired by other callers, allowing duplicate computation.
Functions
async_acquire_lock()
async_acquire_lock()def async_acquire_lock(
records: RecordStore, key: str, holder: str, ttl_seconds: float
) -> bool: ...Acquire in a thread without stranding a lock if the caller is cancelled.
recordsRecordStore — Record database owning the lease.keystr — Computation to lock.holderstr — Unique identity for this acquisition.ttl_secondsfloat — Lease lifetime.
async_lookup_or_acquire()
async_lookup_or_acquire()def async_lookup_or_acquire(
records: RecordStore,
store: ContentStoreBase,
key: str,
holder: str,
ttl_seconds: float = 60.0,
poll_interval_seconds: float = 0.05,
on_wait: Callable[[], None] | None = None,
) -> Hit | Acquired: ...Await a verified cache hit or acquire the computation lease.
Use event-loop polling; only database operations occupy worker threads.
recordsRecordStore — Record store backing both the record and lock tables.storeContentStoreBase — Content store verifying hit payloads.keystr — The envelope key to look up or acquire.holderstr — This caller’s opaque identity. Must be passed again torelease/renew.ttl_secondsfloat — Lock lease duration.poll_interval_secondsfloat — Delay between polls while waiting.on_waitCallable[[], None] | None — Called once if another caller holds the lease.
Hit, or an Acquired lease.lookup_or_acquire()
lookup_or_acquire()def lookup_or_acquire(
records: RecordStore,
store: ContentStoreBase,
key: str,
holder: str,
ttl_seconds: float = 60.0,
poll_interval_seconds: float = 0.05,
) -> Hit | Acquired: ...Wait for a verified cache hit or acquire the computation lease.
Poll until a result is available or the lease can be acquired.
recordsRecordStore — Record store backing both the record and lock tables.storeContentStoreBase — Content store verifying hit payloads.keystr — The envelope key to look up or acquire.holderstr — Caller identity, reused forreleaseandrenew.ttl_secondsfloat — Lease duration; renew before expiry if computation takes longer.poll_interval_secondsfloat — Sleep between polls while waiting.
Hit, or an Acquired lease that the caller must release after committing its result.release()
release()def release(records: RecordStore, key: str, holder: str) -> None: ...Release the lock on key, only if holder still owns it.
recordsRecordStore — Record store backing the lock table.keystr — The envelope key whose lock should be released.holderstr — This caller’s opaque identity, as passed tolookup_or_acquire.
renew()
renew()def renew(
records: RecordStore, key: str, holder: str, ttl_seconds: float
) -> bool: ...Extend the lease on key, only if holder still owns it.
Sessions renew automatically; other callers must arrange renewal.
recordsRecordStore — Record store backing the lock table.keystr — The envelope key whose lease should be extended.holderstr — This caller’s opaque identity, as passed tolookup_or_acquire.ttl_secondsfloat — New lease duration from now.
True if renewed, False if holder no longer owns the lock (e.g. it was already stolen after expiring).Classes
Acquired
Acquiredclass Acquired(builtins.object):
def __init__(self, holder: str) -> None: ...A lease requiring the caller to compute, commit, and release.
holderstr — This caller’s opaque identity, to be passed torelease/renewafter computing.