Class PayloadReader

A FDv2 PayloadReader can be used to parse payloads from a stream of FDv2 events. It will send payloads to the PayloadListeners as the payloads are received. Invalid series of events may be dropped silently, but the payload reader will continue to operate.

Hierarchy

  • PayloadReader

Constructors

constructor

Properties

_attachHandler _errorHandler? _listeners _logger? _objProcessors _processDeleteObject _processError _processGoodbye _processObj _processPayloadTransferred _processPutObject _processServerIntent _resetState _tempBasis? _tempId? _tempUpdates

Methods

addPayloadListener removePayloadListener

Constructors

constructor

  • Creates a PayloadReader

    Parameters

    • eventStream: EventStream

      event stream of FDv2 events

    • _objProcessors: ObjProcessors

      defines object processors for each object kind.

    • Optional _errorHandler: ((errorKind, message) => void)

      that will be called with errors as they are encountered

      Optional
        • (errorKind, message): void

        • Parameters

          Returns void

    • Optional _logger: LDLogger

      for logging

      Optional

    Returns PayloadReader

Properties

Private _attachHandler

_attachHandler: any

Private Optional Readonly _errorHandler

_errorHandler?: any

Private _listeners

_listeners: any

Private Optional Readonly _logger

_logger?: any

Private Readonly _objProcessors

_objProcessors: any

Private _processDeleteObject

_processDeleteObject: any

Private _processError

_processError: any

Private _processGoodbye

_processGoodbye: any

Private _processObj

_processObj: any

Private _processPayloadTransferred

_processPayloadTransferred: any

Private _processPutObject

_processPutObject: any

Private _processServerIntent

_processServerIntent: any

Private _resetState

_resetState: any

Private Optional _tempBasis

_tempBasis?: any

Private Optional _tempId

_tempId?: any

Private _tempUpdates

_tempUpdates: any

Methods

addPayloadListener

  • Parameters

    Returns void

removePayloadListener

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc