Struct matrix_sdk::store_locks::CrossProcessStoreLock

pub struct CrossProcessStoreLock<S>
where
    S: BackingStore + Clone + SendOutsideWasm + 'static,
{ /* private fields */ }

A store-based lock for a Store.

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

Implementations

impl<S> CrossProcessStoreLock<S>

where S: BackingStore + Clone + SendOutsideWasm + 'static,

pub fn new( store: S, lock_key: String, lock_holder: String, ) -> CrossProcessStoreLock<S>

Create a new store-based lock implemented as a value in the store.

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<CrossProcessStoreLockGuard>, LockStoreError>

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

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

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<S> Clone for CrossProcessStoreLock<S>

where S: Clone + BackingStore + SendOutsideWasm + 'static,

fn clone(&self) -> CrossProcessStoreLock<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for CrossProcessStoreLock<S>

where S: Debug + BackingStore + Clone + SendOutsideWasm + 'static,

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

Formats the value using the given formatter.