Interface IRealtimeHandlerErrorReporter

Failure and recovery sink used by dispatchRealtimeFrame. Methods must not throw, including when called from a promise reaction.

Since

0.11.0

interface IRealtimeHandlerErrorReporter {
    failed(
        handler: RealtimeFrameHandler,
        error: unknown,
        frame: RealtimeFrame,
    ): void;
    succeeded(handler: RealtimeFrameHandler): void;
}

Index

Methods

failed succeeded

Methods

failed

failed(
    handler: RealtimeFrameHandler,
    error: unknown,
    frame: RealtimeFrame,
): void
Records a synchronous throw or asynchronous rejection.
Parameters
- handler: RealtimeFrameHandler
  The failed subscriber, used as a weak identity key
- error: unknown
  The thrown or rejected value
- frame: RealtimeFrame
  The arriving frame; its payload must never be logged
Returns void
Nothing
- Defined in packages/common/src/realtime/handler-errors.ts:25

succeeded

succeeded(handler: RealtimeFrameHandler): void
Records a synchronous return or asynchronous fulfilment.
Parameters
- handler: RealtimeFrameHandler
  The subscriber that completed successfully
Returns void
Nothing
- Defined in packages/common/src/realtime/handler-errors.ts:31