Class Status

Hierarchy

  • StartStop
    • Status

Constructors

constructor

Properties

[initLock] fs logger statusLockFile statusLockPath statusPath statusReplacer statusReviver

Accessors

[eventHandled] [eventHandlers] [eventTarget] [handleEventError] [running] [statusP] [status]

Methods

addEventListener beginStop dispatchEvent finishStart readStatus removeEventListener start stop updateStatusLive waitFor writeStatus

Constructors

constructor

  • Parameters

    • __namedParameters: {
          fs?: FileSystem;
          logger?: Logger;
          statusLockPath: string;
          statusPath: string;
      }
      • Optional fs?: FileSystem
      • Optional logger?: Logger
      • statusLockPath: string
      • statusPath: string

    Returns Status

Properties

Readonly [initLock]

[initLock]: RWLockWriter

Protected fs

fs: FileSystem

Protected logger

logger: Logger

Protected statusLockFile

statusLockFile: FileHandle

Readonly statusLockPath

statusLockPath: string

Readonly statusPath

statusPath: string

Protected statusReplacer

statusReplacer: ((key, value) => any) = ...

Type declaration

    • (key, value): any

    • Replacer used during encoding to JSON This is a function expression and not an arrow function expression because it needs to access the this inside the JSON.stringify in order to encode the NodeId before the toJSON of IdInternal is called

      Parameters

      • key: string
      • value: any

      Returns any

Protected statusReviver

statusReviver: ((key, value) => any) = ...

Type declaration

    • (key, value): any

    • Reviver used during decoding from JSON

      Parameters

      • key: string
      • value: any

      Returns any

Accessors

[eventHandled]

  • get [eventHandled](): ReadonlyWeakSet<Event>

  • Returns ReadonlyWeakSet<Event>

[eventHandlers]

  • get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>

  • Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

  • get [eventTarget](): EventTarget

  • Returns EventTarget

[handleEventError]

  • get [handleEventError](): ((evt) => void)

  • Returns ((evt) => void)

      • (evt): void

      • Parameters

        • evt: EventError

        Returns void

[running]

  • get [running](): boolean

  • Returns boolean

[statusP]

  • get [statusP](): Promise<Status>

  • Returns Promise<Status>

[status]

  • get [status](): Status

  • Returns Status

Methods

addEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

beginStop

  • Parameters

    • data: {
          pid: number;
          [key: string]: any;
      }
      • [key: string]: any
      • pid: number

    Returns Promise<void>

dispatchEvent

  • Parameters

    • event: Event

    Returns boolean

finishStart

  • Parameters

    • data: {
          agentHost: string;
          agentPort: number;
          clientHost: string;
          clientPort: number;
          nodeId: NodeId;
          pid: number;
          [key: string]: any;
      }
      • [key: string]: any
      • agentHost: string
      • agentPort: number
      • clientHost: string
      • clientPort: number
      • nodeId: NodeId
      • pid: number

    Returns Promise<void>

readStatus

removeEventListener

  • Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

start

  • Parameters

    • data: {
          pid: number;
          [key: string]: any;
      }
      • [key: string]: any
      • pid: number

    Returns Promise<void>

stop

  • Parameters

    • data: {
          [key: string]: any;
      }
      • [key: string]: any

    Returns Promise<void>

updateStatusLive

  • Parameters

    • data: Partial<{
          agentHost: string;
          agentPort: number;
          clientHost: string;
          clientPort: number;
          nodeId: NodeId;
          pid: number;
          [key: string]: any;
      }>

    Returns Promise<StatusInfo>

waitFor

Protected writeStatus

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc