Class WebSocketConnectionFramed

Something that can be closed

Hierarchy

WebSocketConnectionBase
- WebSocketConnectionFramed

Implements

IWebSocketConnectionFramed

Index

Constructors

Properties

_cv _error socket

Accessors

localAddress remoteAddress

Methods

close closeWithCode onMessage readFrame writeFrame

Constructors

constructor

new WebSocketConnectionFramed(socket: WebSocket): WebSocketConnectionFramed
Parameters
- socket: WebSocket
Returns WebSocketConnectionFramed
Inherited from WebSocketConnectionBase.constructor
- Defined in packages/net/src/websocket.ts:26

Properties

`Protected`_cv

_cv: ConditionVariable

`Protected`_error

_error: null | Error = null

`Readonly`socket

socket: WebSocket

Accessors

localAddress

get localAddress(): never
Returns never
Inherited from WebSocketConnectionBase.localAddress
- Defined in packages/net/src/websocket.ts:49

remoteAddress

get remoteAddress(): null | string
Returns null | string
Inherited from WebSocketConnectionBase.remoteAddress
- Defined in packages/net/src/websocket.ts:45

Methods

close

close(): void
Close the underlying source.

Returns void
Implementation of IWebSocketConnectionFramed.close
Inherited from WebSocketConnectionBase.close
- Defined in packages/net/src/websocket.ts:53

closeWithCode

closeWithCode(code: number, reason?: string): void
Parameters
- code: number
- Optionalreason: string
Returns void
Inherited from WebSocketConnectionBase.closeWithCode
- Defined in packages/net/src/websocket.ts:59

onMessage

onMessage(event: MessageEvent<any>): void
Parameters
- event: MessageEvent<any>
Returns void
Overrides WebSocketConnectionBase.onMessage
- Defined in packages/net/src/websocket.ts:118

readFrame

readFrame(): Promise<string | Uint8Array>
Returns Promise<string | Uint8Array>
Implementation of IWebSocketConnectionFramed.readFrame
- Defined in packages/net/src/websocket.ts:126

writeFrame

writeFrame(data: string | Uint8Array): Promise<void>
Parameters
- data: string | Uint8Array
Returns Promise<void>
Implementation of IWebSocketConnectionFramed.writeFrame
- Defined in packages/net/src/websocket.ts:141