API Docs for: 0.8.0
Show:

LockService Class

Defined in: include/service/locks/lock_service.js:25
Module: Services

Constructor

LockService

(
  • [provider]
)

Defined in include/service/locks/lock_service.js:25

Parameters:

  • [provider] LockProvider optional

Item Index

Methods

Properties

Methods

acquire

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

Defined in include/service/locks/lock_service.js:47

Attempts to acquire a semaphore 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/lock_service.js:74

Retrieves the payload for the lock

Parameters:

  • name String
  • cb Function

loadProvider

() LockProvider static

Defined in include/service/locks/lock_service.js:95

Inspects the current PB configuration to determine what lock provider to instantiate and return

Returns:

LockProvider:

An instance of a media provider or NULL when no provider can be loaded.

release

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

Defined in include/service/locks/lock_service.js:84

Releases the lock

Parameters:

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

Properties

provider

MediaProvider

Defined in include/service/locks/lock_service.js:39