pub struct LockOptions {
pub stale_after_ms: Option<u64>,
pub heartbeat_ms: Option<u64>,
pub timeout_ms: Option<u64>,
pub retry_interval_ms: Option<u64>,
pub grace_served: Option<GraceServed>,
}Expand description
How the writer lock on a database directory is taken.
timeout_ms bounds how long acquire waits for another writer to leave before it gives up
with LockedError; 0 fails on the first refusal. retry_interval_ms is the polling step
while waiting. stale_after_ms is the heartbeat age after which a lock is treated as abandoned
and reclaimed; heartbeat_ms is how often the holder refreshes its own heartbeat.
Reclaiming an expired lease costs a further stale_after_ms / 2 of grace on top, and is only
attempted when timeout_ms leaves room for it — so a timeout shorter than that grace never
reclaims, it just reports the directory as locked. grace_served is how a caller that waited
that grace out on its own clock skips the wait acquire would otherwise do inside itself.
Fields§
§stale_after_ms: Option<u64>§heartbeat_ms: Option<u64>§timeout_ms: Option<u64>§retry_interval_ms: Option<u64>§grace_served: Option<GraceServed>A lease this caller already challenged and waited out, so the first pass that finds that very lease still expired reclaims it without sleeping. Spent on that pass whether the reclaim lands or not; a token naming any other lease is ignored and the ordinary, sleeping hand-over runs instead.