Struct CrossProcessLock 

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

A cross-process lock implementation.

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, ) -> CrossProcessLock<L>

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 fn is_dirty(&self) -> bool

Determine whether the cross-process lock is dirty.

See CrossProcessLockState::Dirty to learn more about the semantics of dirty.

pub fn clear_dirty(&self)

Clear the dirty state from this cross-process lock.

If the cross-process lock is dirtied, it will remain dirtied until this method is called. This allows recovering from a dirty state and marking that it has recovered.

pub async fn try_lock_once( &self, ) -> Result<Result<CrossProcessLockState, CrossProcessLockUnobtained>, <L as TryLock>::LockError>

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

The lock can be obtained but it can be dirty. In all cases, the renew task will run in the background.

pub async fn spin_lock( &self, max_backoff: Option<u32>, ) -> Result<Result<CrossProcessLockState, CrossProcessLockUnobtained>, <L as TryLock>::LockError>

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: Clone + TryLock + SendOutsideWasm + 'static,

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: Debug + TryLock + Clone + SendOutsideWasm + 'static,

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

Formats the value using the given formatter.