Class PayloadProcessor

A FDv2 PayloadProcessor 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 processor will continue to operate.

Hierarchy

  • PayloadProcessor

Constructors

constructor

Properties

_errorHandler? _listeners _logger? _objProcessors _processDeleteObject _processError _processGoodbye _processIntentNone _processObj _processPayloadTransferred _processPutObject _processServerIntent _resetAfterEmission _resetAfterError _resetAll _tempBasis _tempId? _tempUpdates

Methods

addPayloadListener processEvents removePayloadListener

Constructors

constructor

  • Creates a PayloadProcessor

    Parameters

    • _objProcessors: ObjProcessors

      defines object processors for each object kind.

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

      that will be called with parsing errors as they are encountered

      Optional
        • (errorKind, message): void

        • Parameters

          Returns void

    • Optional _logger: LDLogger

      for logging

      Optional

    Returns PayloadProcessor

Properties

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 _processIntentNone

_processIntentNone: any

Private _processObj

_processObj: any

Private _processPayloadTransferred

_processPayloadTransferred: any

Private _processPutObject

_processPutObject: any

Private _processServerIntent

_processServerIntent: any

Private _resetAfterEmission

_resetAfterEmission: any

Private _resetAfterError

_resetAfterError: any

Private _resetAll

_resetAll: any

Private _tempBasis

_tempBasis: any

Private Optional _tempId

_tempId?: any

Private _tempUpdates

_tempUpdates: any

Methods

addPayloadListener

  • Parameters

    Returns void

processEvents

  • Gives the PayloadProcessor a series of events that it will statefully, incrementally process. This may lead to listeners being invoked as necessary.

    Parameters

    • events: FDv2Event[]

      to be processed (can be a single element)

    Returns void

removePayloadListener

  • Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc