Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transport

Hierarchy

  • Transport

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly closeEvent

closeEvent: { addEventListener: (callback: (...args: [error?: Error]) => void) => () => void; waitForNext: () => Promise<[error?: Error]> } = ...

Type declaration

  • addEventListener: (callback: (...args: [error?: Error]) => void) => () => void
      • (callback: (...args: [error?: Error]) => void): () => void

      • Parameters

        • callback: (...args: [error?: Error]) => void
            • (...args: [error?: Error]): void

            • Parameters

              • Rest ...args: [error?: Error]

              Returns void

        Returns () => void

          • (): void

          • Returns void

  • waitForNext: () => Promise<[error?: Error]>
      • (): Promise<[error?: Error]>

      • Returns Promise<[error?: Error]>

Readonly messageEvent

messageEvent: { addEventListener: (callback: (...args: [message: WampMessage]) => void) => () => void; waitForNext: () => Promise<[message: WampMessage]> } = ...

Type declaration

  • addEventListener: (callback: (...args: [message: WampMessage]) => void) => () => void
      • (callback: (...args: [message: WampMessage]) => void): () => void

      • Parameters

        • callback: (...args: [message: WampMessage]) => void
            • (...args: [message: WampMessage]): void

            • Parameters

              • Rest ...args: [message: WampMessage]

              Returns void

        Returns () => void

          • (): void

          • Returns void

  • waitForNext: () => Promise<[message: WampMessage]>
      • (): Promise<[message: WampMessage]>

      • Returns Promise<[message: WampMessage]>

Readonly openEvent

openEvent: { addEventListener: (callback: (...args: []) => void) => () => void; waitForNext: () => Promise<[]> } = ...

Type declaration

  • addEventListener: (callback: (...args: []) => void) => () => void
      • (callback: (...args: []) => void): () => void

      • Parameters

        • callback: (...args: []) => void
            • (...args: []): void

            • Parameters

              • Rest ...args: []

              Returns void

        Returns () => void

          • (): void

          • Returns void

  • waitForNext: () => Promise<[]>
      • (): Promise<[]>

      • Returns Promise<[]>

Accessors

isClosed

  • get isClosed(): boolean

  • Returns boolean

Methods

_send

  • _send<T>(messageType: T, data: MessageData[T]): void

  • For use internally within the library

    Type parameters

    • T: MessageTypes

    Parameters

    • messageType: T
    • data: MessageData[T]

    Returns void

close

  • close(err?: Error): void

  • Parameters

    • Optional err: Error

    Returns void

open

  • open(): void

  • Returns void

read

  • read(): Promise<WampMessage>

  • An exception indicates that the transport has been closed and there will be no more messages to read on this transport.

    Returns Promise<WampMessage>

write

  • write(payload: WampMessage): void

  • Parameters

    • payload: WampMessage

    Returns void

Generated using TypeDoc