Class Alarm

Simple but accurate alarm that makes use of high-resolution timer. The algorithm is inspired by nanotimer, written by Kevin Briggs.

Author

Marten Lohstroh (marten@berkeley.edu)

Constructors

constructor

Properties

active deferredRef hiResDelay hiResStart immediateRef loResDelay

Methods

set unset

Constructors

constructor

Properties

active

active: boolean = false

Indicates whether the alarm has been set or not.

deferredRef

deferredRef: undefined | Timeout

Handle for regular timeout, used for delays > 25 ms.

hiResDelay

hiResDelay: [number, number] = ...

The delay interval in high resolution; tuple of seconds and nanoseconds.

hiResStart

hiResStart: [number, number] = ...

Start of the delay interval; tuple of seconds and nanoseconds.

immediateRef

immediateRef: undefined | Immediate

Handle for immediate, used for polling once the remaining delay is < 25 ms.

loResDelay

loResDelay: number = 0

Delay in terms of milliseconds, used when deferring to regular timeout.

Methods

set

  • set(task, delay, callback?): void

  • Set the alarm.

    Parameters

    • task: (() => void)

      The task to be performed.

        • (): void

        • Returns void

    • delay: TimeValue

      The time has to elapse before the task can be performed.

    • Optionalcallback: ((waitTime: TimeValue) => void)

      Optional callback used to report the wait time.

        • (waitTime): void

        • Parameters

          Returns void

    Returns void

unset

  • unset(): void

  • Disable any scheduled timeouts or immediate events, and set the timer to inactive.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods