Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutexAPI

Mutex API

Hierarchy

  • MutexAPI

Index

Properties

Methods

Properties

registry

registry: any

Mutex registry.

w96.mutex.registry[id] = <mtx object>.

Methods

create

  • create(tag?: any): string

  • Creates a new mutex.

    Parameters

    • Optional tag: any

      An optional tag to specify.

    Returns string

    A mutex ID.

find

  • find(tag: string): string

  • Gets a mutex by tag.

    Parameters

    • tag: string

      The tag to search for.

    Returns string

    The found mutex ID.

isLocked

  • isLocked(id: string): boolean

  • Checks for a lock.

    Parameters

    • id: string

      The ID of the mutex to check.

    Returns boolean

release

  • release(id: string): void

  • Releases the specified mutex.

    Parameters

    • id: string

      The ID of the mutex to release.

    Returns void

Generated using TypeDoc