Class IPCMessageWriter

Writes JSON-RPC messages to an underlying transport.

Hierarchy (View Summary)

Implements

Constructors

constructor

Accessors

onClose onError

Methods

dispose end fireClose fireError write

Constructors

constructor

Accessors

onClose

  • get onClose(): Event<void>

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

    Returns Event<void>

onError

  • get onError(): Event<[Error, undefined | Message, undefined | number]>

  • Raised whenever an error occurs while writing a message.

    Returns Event<[Error, undefined | Message, undefined | number]>

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

ProtectedfireClose

  • fireClose(): void

  • Returns void

ProtectedfireError

  • fireError(error: any, message?: Message, count?: number): void

  • Parameters

    • error: any
    • Optionalmessage: Message
    • Optionalcount: number

    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

Constructors
Accessors
Methods