Class AbstractMessageReaderAbstract

Reads JSON-RPC messages from some underlying transport.

Hierarchy (View Summary)

Implements

Constructors

constructor

Accessors

onClose onError onPartialMessage

Methods

dispose fireClose fireError firePartialMessage listen

Constructors

constructor

Accessors

onClose

  • get onClose(): Event<void>

  • An event raised when the end of the underlying transport has been reached.

    Returns Event<void>

onError

  • get onError(): Event<Error>

  • Raised whenever an error occurs while reading a message.

    Returns Event<Error>

onPartialMessage

  • get onPartialMessage(): Event<PartialMessageInfo>

  • An event that may be raised to inform the owner that only part of a message has been received. A MessageReader implementation may choose to raise this event after a timeout elapses while waiting for more of a partially received message to be received.

    Returns Event<PartialMessageInfo>

Methods

dispose

  • dispose(): void

  • Releases resources incurred from reading or raising events. Does NOT close the underlying transport, if any.

    Returns void

ProtectedfireClose

  • fireClose(): void

  • Returns void

ProtectedfireError

  • fireError(error: any): void

  • Parameters

    • error: any

    Returns void

ProtectedfirePartialMessage

  • firePartialMessage(info: PartialMessageInfo): void

  • Parameters

    Returns void

Abstractlisten

  • listen(callback: DataCallback): Disposable

  • Begins listening for incoming messages. To be called at most once.

    Parameters

    • callback: DataCallback

      A callback for receiving decoded messages.

    Returns Disposable

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods