Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RICMsgHandler

Hierarchy

  • RICMsgHandler

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _addOnManager

_addOnManager: RICAddOnManager

Private _commsStats

_commsStats: RICCommsStats

Private _currentMsgHandle

_currentMsgHandle: number = 1

Private _currentMsgNumber

_currentMsgNumber: number = 1

Private _miniHDLC

_miniHDLC: RICMiniHDLC

Private _msgResultHandler

_msgResultHandler: null | RICMessageResult = null

Private _msgSender

_msgSender: null | RICMessageSender = null

Private _msgTrackInfos

_msgTrackInfos: RICMsgTrackInfo[] = ...

Private _msgTrackLastCheckIdx

_msgTrackLastCheckIdx: number = 0

Private _msgTrackTimerMs

_msgTrackTimerMs: number = 50

Private _reportMsgCallbacks

_reportMsgCallbacks: Map<string, ((report: RICReportMsg) => void)> = ...

Methods

_handleReportMessages

  • _handleReportMessages(restStr: string): void

_handleResponseMessages

  • _handleResponseMessages(restStr: string, rxMsgNum: number): void

_msgCompleted

  • _msgCompleted(msgNum: number, msgRsltCode: RICMsgResultCode, msgRsltObj: null | object): void

  • Parameters

    • msgNum: number
    • msgRsltCode: RICMsgResultCode
    • msgRsltObj: null | object

    Returns void

_onHDLCFrameDecode

  • _onHDLCFrameDecode(rxMsg: Uint8Array): void

_onMsgTrackTimer

  • _onMsgTrackTimer(chainRecall: boolean): Promise<void>

encodeFileStreamBlock

  • encodeFileStreamBlock(blockContents: Uint8Array, blockStart: number, streamID: number): Uint8Array

  • Parameters

    • blockContents: Uint8Array
    • blockStart: number
    • streamID: number

    Returns Uint8Array

frameCommsMsg

  • frameCommsMsg(msgPayload: Uint8Array, msgDirection: RICCommsMsgTypeCode, msgProtocol: RICCommsMsgProtocol, isNumbered: boolean): Uint8Array

  • Parameters

    • msgPayload: Uint8Array
    • msgDirection: RICCommsMsgTypeCode
    • msgProtocol: RICCommsMsgProtocol
    • isNumbered: boolean

    Returns Uint8Array

handleNewRxMsg

  • handleNewRxMsg(rxMsg: Uint8Array): void

msgTrackingRxRespMsg

  • msgTrackingRxRespMsg(msgNum: number, msgRsltCode: RICMsgResultCode, msgRsltJsonObj: object): void

  • Parameters

    • msgNum: number
    • msgRsltCode: RICMsgResultCode
    • msgRsltJsonObj: object

    Returns void

msgTrackingTxCmdMsg

  • msgTrackingTxCmdMsg<T>(msgFrame: Uint8Array, withResponse: boolean, msgTimeoutMs: undefined | number, resolve: ((arg: T) => void), reject: ((reason: Error) => void)): void

  • Type Parameters

    • T

    Parameters

    • msgFrame: Uint8Array
    • withResponse: boolean
    • msgTimeoutMs: undefined | number
    • resolve: ((arg: T) => void)
        • (arg: T): void

        • Parameters

          • arg: T

          Returns void

    • reject: ((reason: Error) => void)
        • (reason: Error): void

        • Parameters

          • reason: Error

          Returns void

    Returns void

registerForResults

  • registerForResults(msgResultHandler: RICMessageResult): void

registerMsgSender

  • registerMsgSender(RICMessageSender: RICMessageSender): void

reportMsgCallbacksDelete

  • reportMsgCallbacksDelete(callbackName: string): void

reportMsgCallbacksSet

  • reportMsgCallbacksSet(callbackName: string, callback: ((report: RICReportMsg) => void)): void

sendFileBlock

  • sendFileBlock(blockContents: Uint8Array, blockStart: number): Promise<boolean>

  • Parameters

    • blockContents: Uint8Array
    • blockStart: number

    Returns Promise<boolean>

sendMsgAndWaitForReply

  • sendMsgAndWaitForReply<T>(msgPayload: Uint8Array, msgDirection: RICCommsMsgTypeCode, msgProtocol: RICCommsMsgProtocol, withResponse: boolean, msgTimeoutMs: undefined | number): Promise<T>

  • Type Parameters

    • T

    Parameters

    • msgPayload: Uint8Array
    • msgDirection: RICCommsMsgTypeCode
    • msgProtocol: RICCommsMsgProtocol
    • withResponse: boolean
    • msgTimeoutMs: undefined | number

    Returns Promise<T>

sendRICREST

  • sendRICREST<T>(cmdStr: string, ricRESTElemCode: RICRESTElemCode, msgTimeoutMs?: undefined | number): Promise<T>

  • Type Parameters

    • T

    Parameters

    • cmdStr: string
    • ricRESTElemCode: RICRESTElemCode
    • msgTimeoutMs: undefined | number = undefined

    Returns Promise<T>

sendRICRESTBytes

  • sendRICRESTBytes<T>(cmdBytes: Uint8Array, ricRESTElemCode: RICRESTElemCode, withResponse: boolean, msgTimeoutMs?: undefined | number): Promise<T>

  • Type Parameters

    • T

    Parameters

    • cmdBytes: Uint8Array
    • ricRESTElemCode: RICRESTElemCode
    • withResponse: boolean
    • msgTimeoutMs: undefined | number = undefined

    Returns Promise<T>

sendRICRESTCmdFrame

  • sendRICRESTCmdFrame<T>(cmdStr: string, msgTimeoutMs?: undefined | number): Promise<T>

  • Type Parameters

    • T

    Parameters

    • cmdStr: string
    • msgTimeoutMs: undefined | number = undefined

    Returns Promise<T>

sendRICRESTURL

  • sendRICRESTURL<T>(cmdStr: string, msgTimeoutMs?: undefined | number): Promise<T>

  • Type Parameters

    • T

    Parameters

    • cmdStr: string
    • msgTimeoutMs: undefined | number = undefined

    Returns Promise<T>

sendStreamBlock

  • sendStreamBlock(blockContents: Uint8Array, blockStart: number, streamID: number): Promise<boolean>

  • Parameters

    • blockContents: Uint8Array
    • blockStart: number
    • streamID: number

    Returns Promise<boolean>

Generated using TypeDoc