Interface MessageWriter

Writes JSON-RPC messages to an underlying transport.

interface MessageWriter {
    onClose: Event<void>;
    onError: Event<[Error, undefined | Message, undefined | number]>;
    dispose(): void;
    end(): void;
    write(msg: Message): Promise<void>;
}

Implemented by

Properties

onClose onError

Methods

dispose end write

Properties

ReadonlyonClose

onClose: Event<void>

An event raised when the underlying transport has closed and writing is no longer possible.

ReadonlyonError

onError: Event<[Error, undefined | Message, undefined | number]>

Raised whenever an error occurs while writing a message.

Methods

dispose

  • dispose(): void

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

    Returns void

end

  • end(): void

  • Call when the connection using this message writer ends (e.g. MessageConnection.end() is called)

    Returns void

write

  • write(msg: Message): Promise<void>

  • Sends a JSON-RPC message.

    Parameters

    • msg: Message

      The JSON-RPC message to be sent.

    Returns Promise<void>

    Description

    Implementations should guarantee messages are transmitted in the same order that they are received by this method.

Settings

Member Visibility

On This Page

Properties
Methods