Class Sockets

Index

Constructors

Accessors

Methods

all close createWebSocket createWebTransport get

Constructors

constructor

new Sockets(options: SocketsOptions): Sockets
Parameters
- options: SocketsOptions
Returns Sockets
- Defined in core/kernel/src/tree/sockets.ts:9

Accessors

kernel

get kernel(): Kernel
Returns Kernel
- Defined in core/kernel/src/tree/sockets.ts:7

Methods

all

all(): Map<string, SocketConnection>
Get all socket connections

Returns Map<string, SocketConnection>
A map of all socket connections
- Defined in core/kernel/src/tree/sockets.ts:160

close

close(id: string): Promise<void>
Close a socket connection
Parameters
- id: string
  The ID of the connection to close
Returns Promise<void>
- Defined in core/kernel/src/tree/sockets.ts:140

createWebSocket

createWebSocket(
url: string,
options?: { protocols?: string | string[] },
): Promise<WebSocketConnection>
Create a WebSocket connection
Parameters
- url: string
  The URL to connect to
- Optionaloptions: { protocols?: string | string[] }
  The options for the WebSocket connection
Returns Promise<WebSocketConnection>
The WebSocket connection
- Defined in core/kernel/src/tree/sockets.ts:19

createWebTransport

createWebTransport(
url: string,
options?: { allowPooling?: boolean },
): Promise<WebTransportConnection>
Create a WebTransport connection
Parameters
- url: string
  The URL to connect to
- Optionaloptions: { allowPooling?: boolean }
  The options for the WebTransport connection
Returns Promise<WebTransportConnection>
The WebTransport connection
- Defined in core/kernel/src/tree/sockets.ts:86

get

get(id: string): undefined | SocketConnection
Get a socket connection
Parameters
- id: string
  The ID of the connection to get
Returns undefined | SocketConnection
The socket connection
- Defined in core/kernel/src/tree/sockets.ts:152