mps.sync.TimedRedisMutex

R2026b

Represent a Redis persistence service mutex

Description

mps.sync.TimedRedisMutex is a synchronization primitive used to protect data in a Redis™ persistence service from being simultaneously accessed by multiple workers.

Creation

Create a mps.sync.TimedRedisMutex object using mps.sync.mutex.

Properties

Expiration — Duration of lock in seconds

Read-only: positive integer

This property is read-only.

Duration of advisory lock in seconds.

Example: 10

ConnectionName — Name of connection

Read-only: character vector

This property is read-only.

Name of connection to persistence service.

Example: 'myRedisConnection'

MutexName — Name of mutex

Read-only: character vector

This property is read-only.

Name of mutex, returned as a character vector.

Example: 'myMutex'

Object Functions

mps.sync.mutex	Create a persistence service mutex
acquire	Acquire advisory lock on persistence service mutex
own	Check ownership of advisory lock on a persistence service mutex object
release	Release advisory lock on persistence service mutex

Examples

Create a Redis Lock Object

• ctrl = mps.cache.control('myRedisConnection','Redis','Port',4519);
  start(ctrl)
  lk = mps.sync.mutex('myMutex','Connection','myRedisConnection')

  lk = 
  
    TimedRedisMutex with properties:
  
          Expiration: 10
      ConnectionName: 'myRedisConnection'
           MutexName: 'myMutex'

Version History

Introduced in R2018b