Class TlsMultiplexedWebSocketConnection

constructor

• new TlsMultiplexedWebSocketConnection(
      websocketUrl: string,
      autoReconnect?: boolean,
  ): TlsMultiplexedWebSocketConnection

  Creates a TLS Client over WebSocket

  Parameters

  • websocketUrl: string
  • OptionalautoReconnect: boolean

  Returns TlsMultiplexedWebSocketConnection

onNoBackendConnection

debugEnabled

addEventListener

• addEventListener<K extends keyof WebSocketEventMap>(
      type: K,
      listener: (this: WebSocket, ev: WebSocketEventMap[K]) => unknown,
      options?: boolean | AddEventListenerOptions,
  ): void

  Allows attachment of events to the underlying WebSocket

  Type Parameters

  • K extends keyof WebSocketEventMap

  Parameters

  • type: K
  • listener: (this: WebSocket, ev: WebSocketEventMap[K]) => unknown
  • Optionaloptions: boolean | AddEventListenerOptions

  Returns void

removeEventListener

• removeEventListener<K extends keyof WebSocketEventMap>(
      type: K,
      listener: (this: WebSocket, ev: WebSocketEventMap[K]) => unknown,
      options?: boolean | EventListenerOptions,
  ): void

  Allows remove of events to the underlying WebSocket

  Type Parameters

  • K extends keyof WebSocketEventMap

  Parameters

  • type: K
  • listener: (this: WebSocket, ev: WebSocketEventMap[K]) => unknown
  • Optionaloptions: boolean | EventListenerOptions

  Returns void

isAlive

• isAlive(): boolean

  Is WebSocket readyState set to open

  Returns boolean

send

• send(channelNumber: number, data: ArrayBufferView | ArrayBufferLike): void

  Sends a binary message over a Channel

  Parameters

  • channelNumber: number
  • data: ArrayBufferView | ArrayBufferLike

  Returns void

close

• close(channel: number): void

  Sends command to the server to close the Channel. Clean

  Parameters

  • channel: number

  Returns void

createChannel

• createChannel(request: ServiceChannelRequest): Promise<WebSocketChannel>

  create a new channel within the WebSocket.

  Parameters

  • request: ServiceChannelRequest

  Returns Promise<WebSocketChannel>

getSocketProvider

• getSocketProvider(
      backendServiceRequest: ServiceChannelRequest,
      tlsHostname: string,
      tlsCertificateAuthorityPem: string,
      tlsOptions: TlsWebSocketOptions,
  ): TlsWebSocketProvider

  Creates a TlsSocket Provider to an specific Service behind the WebSocketGateway.

  Parameters

  • backendServiceRequest: ServiceChannelRequest

    Identify the Service name, so that the WebSocketGateway can init the route.

  • tlsHostname: string
  • tlsCertificateAuthorityPem: string
  • tlsOptions: TlsWebSocketOptions

  Returns TlsWebSocketProvider