Class WebSocketConnection

A readable stream

Hierarchy

WebSocketConnectionBase
- WebSocketConnection

Implements

IConnection<string, never>

Index

Constructors

Properties

_cv _error socket

Accessors

localAddress remoteAddress

Methods

close closeWithCode onMessage read write

Constructors

constructor

new WebSocketConnection(socket: WebSocket): WebSocketConnection
Parameters
- socket: WebSocket
Returns WebSocketConnection
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
local address of the connection (if available)

Returns never
Implementation of IConnection.localAddress
Inherited from WebSocketConnectionBase.localAddress
- Defined in packages/net/src/websocket.ts:49

remoteAddress

get remoteAddress(): null | string
remote address of the connection (if available)

Returns null | string
Implementation of IConnection.remoteAddress
Inherited from WebSocketConnectionBase.remoteAddress
- Defined in packages/net/src/websocket.ts:45

Methods

close

close(): void
Close the underlying source.

Returns void
Implementation of IConnection.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:71

read

read(into: Uint8Array): Promise<number>
Read data from the underlying source into the provided Uint8Array, up to the length of the array, and return the number of bytes read.

If there are no bytes available currently, the implementation is supposed to wait until at least one byte is available, and only then resolve the promise. Resolving the promise with a zero-length Uint8Array is marking the end of the source.
Parameters
- into: Uint8Array
Returns Promise<number>
Uint8Array containing the bytes that were read.
Implementation of IConnection.read
- Defined in packages/net/src/websocket.ts:83

write

write(bytes: Uint8Array): Promise<void>
Write bytes to the underlying stream, resolving once the write is complete
Parameters
- bytes: Uint8Array
Returns Promise<void>
Implementation of IConnection.write
- Defined in packages/net/src/websocket.ts:102