API Docs for: 0.8.0
Show:

DbLockProvider Class

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

A lock provider that leverages the DB to create semaphores

Constructor

Item Index

Methods

Properties

Methods

acquire

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

Defined in include/service/locks/providers/db_lock_provider.js:51

Attempts to acquire the lock with the given name.

Parameters:

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

      Lock timeout in seconds

  • cb Function

get

(
  • name
  • cb
)

Defined in include/service/locks/providers/db_lock_provider.js:88

Retrieves the payload for the lock

Parameters:

  • name String
  • cb Function

release

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

Defined in include/service/locks/providers/db_lock_provider.js:104

Releases the lock

Parameters:

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

Properties

EXPECTED_ERROR_CODE

Integer private static

Defined in include/service/locks/providers/db_lock_provider.js:41

LOCK_COLLECTION

String private static

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