Mutex #

Available since 2.9.0

Instantiates a new mutex, allowing to lock a resource.
Works both with single-node and cluster environments.

---

Constructor #

Copied to clipboard!

new Mutex(resource, [options]);

Arguments	Type	Description
resource	string	Resource identifier to be locked (must be identical across all nodes for the same resource)
options	object	(optional) Mutex options (see below)

options #

The options object is used to configure the mutex behavior. The following properties can be provided:

Option	Type	Description
attemptDelay	number	(default: 200) Delay in milliseconds between lock attempts
timeout	number	(default: -1) Mutex lock acquisition timeout, in milliseconds. If set to 0, locking will return immediately, whether it can or cannot lock within the 1st attempt. If set to -1, the mutex will try to acquire the resource indefinitely
ttl	number	(default: 5000) Lock time to live, in milliseconds. Locks are freed when unlock is invoked, or after that delay has expired.

---

Usage #

Waiting indefinitely until a resource is available:

Copied to clipboard!

import { Mutex } from 'kuzzle';

async function ConcurrentAccessMethod () {
  const mutex = new Mutex('concurrentAccessMethodResource');

  await mutex.lock();

  try {
    // safe zone: will only be executed once the resource is locked
  }
  finally {
    await mutex.unlock();
  }
}

Making sure that at most 1 task is executed at any given time in a cluster environment:

Copied to clipboard!

import { Mutex, TooManyRequestsError } from 'kuzzle';

async function DoNotRepeatProcess () {
  const mutex = new Mutex('uniqueTask', { timeout: 0 });

  const locked = await mutex.lock();

  if (!locked) {
    throw TooManyRequestsError('That task is already ongoing');
  }

  try {
    // ... do things
  }
  finally {
    await mutex.unlock();
  }
}