API Docs for: 0.8.0
Show:

CacheLockProvider Class

Defined in: include/service/locks/providers/cache_lock_provider.js:24
Module: Services

A lock provider that leverages the cache to create semaphores

Constructor

Item Index

Methods

Methods

acquire

(
  • name
  • [options={}]
  • cb
)

Defined in include/service/locks/providers/cache_lock_provider.js:31

Attempts to acquire the lock with the given name.

Parameters:

  • name String
  • [options={}] Object optional
    • [payload] Object optional
    • [timeout] Integer optional
  • cb Function

get

(
  • name
  • cb
)

Defined in include/service/locks/providers/cache_lock_provider.js:59

Retrieves the payload for the lock

Parameters:

  • name String
  • cb Function

release

(
  • name
  • [options={}]
  • cb
)

Defined in include/service/locks/providers/cache_lock_provider.js:79

Releases the lock

Parameters:

  • name String
  • [options={}] Object optional
  • cb Function