Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UPCStatsSnapshot

The UPCStatsSnapshot class is used to retrieve statistics about the UPC messages that have been processed or are waiting to be processed by Union Server. For example,

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly target

target: EventDispatcher

Methods

addEventListener

  • addEventListener(type: string, listener: Function, thisArg: any, priority?: number): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any
    • Default value priority: number = 0

    Returns boolean

dispatchEvent

  • dispatchEvent(event: Event): void

  • Parameters

    • event: Event

    Returns void

getLastQueueWaitTime

  • getLastQueueWaitTime(): number

  • Returns the amount of time the most-recently processed message spent in the message queue before being processed. To refresh this value to reflect the latest state of the server, pass this UPCStatsSnapshot object to Orbiter.updateSnapshot method.

    Returns number

getListeners

  • getListeners(type: string): EventListener[]

  • Parameters

    • type: string

    Returns EventListener[]

getLongestUPCProcesses

  • Returns a list of the messages that took the longest amount of time to process since the server started. To refresh this value to reflect the latest state of the server, pass this UPCStatsSnapshot object to Orbiter.updateSnapshot method.

    Returns UPCProcessingRecord[] | null

getNumUPCsInQueue

  • getNumUPCsInQueue(): number

  • Returns the number of UPC messages currently waiting to be processed by Union Server. To refresh this value to reflect the latest state of the server, pass this UPCStatsSnapshot object to Orbiter.updateSnapshot method.

    Returns number

getStatus

  • getStatus(): Status | undefined

  • Returns the status of the most recent snapshot load-operation. If a load operation is currently in progress, getStatus() returns null. The possible return values of getStatus() depend on the snapshot type.

    Returns Status | undefined

getTotalUPCsProcessed

  • getTotalUPCsProcessed(): number

  • Returns the total number of UPC messages Union Server has processed since the server started. To refresh this value to reflect the latest state of the server, pass this UPCStatsSnapshot object to Orbiter.updateSnapshot method.

    Returns number

hasListener

  • hasListener(type: string, listener: Function, thisArg: any): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

removeEventListener

  • removeEventListener(type: string, listener: Function, thisArg: any): boolean

  • Parameters

    • type: string
    • listener: Function
    • thisArg: any

    Returns boolean

updateInProgress

  • updateInProgress(): boolean | undefined

  • Indicates whether the snapshot is currently loading data. While an update is in progress, further requests to update the snapshot are ignored.

    Returns boolean | undefined