Class WebSocketChannel

Hierarchy

WebSocketChannel
- TestWebSocketChannel

Implements

IWebSocket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebSocketChannel(id: number, doSend: (content: string) => void): WebSocketChannel

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:28
Parameters
- id: number
- doSend: (content: string) => void
  - - (content: string): void
    - Parameters
      - content: string
      Returns void
Returns WebSocketChannel

Properties

Protected Readonly closeEmitter

closeEmitter: Emitter<[number, string]> = ...

Protected closing

closing: boolean = false

Protected Readonly doSend

doSend: (content: string) => void

Type declaration

- (content: string): void
- Parameters
  - content: string
  Returns void

fireError

fireError: (reason: any) => void = ...

Type declaration

- (reason: any): void
- Parameters
  - reason: any
  Returns void

Protected fireMessage

fireMessage: (data: any) => void = ...

Type declaration

- (data: any): void
- Parameters
  - data: any
  Returns void

Protected fireOpen

fireOpen: () => void = ...

Type declaration

- (): void
- Returns void

Readonly id

id: number

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Static wsPath

wsPath: string = '/services'

Methods

Protected checkNotDisposed

checkNotDisposed(): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:39
Returns void

close

close(code?: number, reason?: string): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:81
Parameters
- code: number = 1000
- reason: string = ''
Returns void

dispose

dispose(): void

Implementation of IWebSocket.dispose
- Defined in packages/core/src/common/messaging/web-socket-channel.ts:35
Returns void

Protected fireClose

fireClose(code: number, reason: string): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:132
Parameters
- code: number
- reason: string
Returns void

handleMessage

handleMessage(message: Message): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:45
Parameters
- message: Message
Returns void

onClose

onClose(cb: (code: number, reason: string) => void): Disposable

Implementation of IWebSocket.onClose
- Defined in packages/core/src/common/messaging/web-socket-channel.ts:144
Parameters
- cb: (code: number, reason: string) => void
  - - (code: number, reason: string): void
    - Parameters
      - code: number
      - reason: string
      Returns void
Returns Disposable

onError

onError(cb: (reason: any) => void): void

Implementation of IWebSocket.onError
- Defined in packages/core/src/common/messaging/web-socket-channel.ts:125
Parameters
- cb: (reason: any) => void
  - - (reason: any): void
    - Parameters
      - reason: any
      Returns void
Returns void

onMessage

onMessage(cb: (data: any) => void): void

Implementation of IWebSocket.onMessage
- Defined in packages/core/src/common/messaging/web-socket-channel.ts:118
Parameters
- cb: (data: any) => void
  - - (data: any): void
    - Parameters
      - data: any
      Returns void
Returns void

onOpen

onOpen(cb: () => void): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:111
Parameters
- cb: () => void
  - - (): void
    - Returns void
Returns void

open

open(path: string): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:55
Parameters
- path: string
Returns void

ready

ready(): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:64
Returns void

send

send(content: string): void

Implementation of IWebSocket.send
- Defined in packages/core/src/common/messaging/web-socket-channel.ts:72
Parameters
- content: string
Returns void

tryClose

tryClose(code?: number, reason?: string): void

- Defined in packages/core/src/common/messaging/web-socket-channel.ts:96
Parameters
- code: number = 1000
- reason: string = ''
Returns void