Struct CrossProcessLock

pub struct CrossProcessLock<L>
where
    L: TryLock + Clone + SendOutsideWasm + 'static,
{ /* private fields */ }

A store-based lock for a Store.

See the doc-comment of this module for more information.

Implementations

impl<L> CrossProcessLock<L>

where L: TryLock + Clone + SendOutsideWasm + 'static,

pub fn new(locker: L, lock_key: String, lock_holder: String) -> Self

Create a new cross-process lock.

Parameters

• lock_key: key in the key-value store to store the lock’s state.
• lock_holder: identify the lock’s holder with this given value.

pub async fn try_lock_once( &self, ) -> Result<Option<CrossProcessLockGuard>, CrossProcessLockError>

Try to lock once, returns whether the lock was obtained or not.

pub async fn spin_lock( &self, max_backoff: Option<u32>, ) -> Result<CrossProcessLockGuard, CrossProcessLockError>

Attempt to take the lock, with exponential backoff if the lock has already been taken before.

The max_backoff parameter is the maximum time (in milliseconds) that should be waited for, between two attempts. When that time is reached a second time, the lock will stop attempting to get the lock and will return a timeout error upon locking. If not provided, will wait for MAX_BACKOFF_MS.

pub fn lock_holder(&self) -> &str

Returns the value in the database that represents the holder’s identifier.

Trait Implementations

impl<L> Clone for CrossProcessLock<L>

where L: TryLock + Clone + SendOutsideWasm + 'static + Clone,

fn clone(&self) -> CrossProcessLock<L>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<L> Debug for CrossProcessLock<L>

where L: TryLock + Clone + SendOutsideWasm + 'static + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.