Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RTJS

an RTJS object is the central object, containing essentially every other objects of note

Hierarchy

  • RTJS

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RTJS(config?: Object): RTJS

  • Parameters

    • Default value config: Object = DEFAULT_RTJS_CONFIG

    Returns RTJS

Properties

config

config: RTJSConfig

system configuration

scheduler

scheduler: Scheduler

the scheduler object

Methods

addAlarm

  • addAlarm(fn: function, delay: number, periodic?: boolean): void

  • Parameters

    • fn: function
        • (): void

        • Returns void

    • delay: number
    • Default value periodic: boolean = false

    Returns void

addTask

  • addTask(task: Task): void

  • add a task to the schedulers queues

    Parameters

    Returns void

addTaskFromFn

  • addTaskFromFn(fn: function, args: any[], config: TaskConfig): void

  • create new task from function and add it to the scheduler

    Parameters

    Returns void

getExecutionTime

  • getExecutionTime(): undefined | number

  • Get the execution time of the currently running task

    Returns undefined | number

getResource

getTime

  • getTime(): number

  • Returns number

    Get a a relative timestamp

pause

  • pause(): void

  • pause the scheduler

    Returns void

releaseResource

spawnTask

  • spawnTask(task: Task): void

  • spawn a new task

    Parameters

    Returns void

spawnTaskFromFn

  • spawnTaskFromFn(fn: function, args: any[], config: TaskConfig): void

start

  • start(): void

  • start / resume the scheduler

    Returns void

taskFromFn

  • create a new task object from a function

    Parameters

    • fn: function

      the generator function / iterator to be turned into a task

    • args: any[]

      the parameters to call the function with

    • config: TaskConfig

      configuration options for the Task-constructor

    Returns Task

Generated using TypeDoc