Class WebSocketTransport

Browser/sidecar adapter using a documentId query parameter and binary frames.

Implements

ObservableCollaborativeTransport

Index

Constructors

Methods

close connect getMetrics getState send subscribe subscribeRecovery subscribeState

Constructors

constructor

new WebSocketTransport(options: WebSocketTransportOptions): WebSocketTransport
Parameters
- options: WebSocketTransportOptions
Returns WebSocketTransport
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:87

Methods

close

close(): Promise<void>
Returns Promise<void>
Implementation of ObservableCollaborativeTransport.close
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:236

connect

connect(documentId: string): Promise<void>
Parameters
- documentId: string
Returns Promise<void>
Implementation of ObservableCollaborativeTransport.connect
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:92

getMetrics

getMetrics(): TransportMetrics
Returns TransportMetrics
Implementation of ObservableCollaborativeTransport.getMetrics
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:218

getState

getState(): TransportConnectionState
Returns TransportConnectionState
Implementation of ObservableCollaborativeTransport.getState
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:214

send

send(update: Uint8Array): Promise<void>
Parameters
- update: Uint8Array
Returns Promise<void>
Implementation of ObservableCollaborativeTransport.send
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:183

subscribe(listener: TransportUpdateListener): () => void
Parameters
- listener: TransportUpdateListener
Returns () => void
Implementation of ObservableCollaborativeTransport.subscribe
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:199

subscribeRecovery

subscribeRecovery(listener: TransportRecoveryListener): () => void
Parameters
- listener: TransportRecoveryListener
Returns () => void
Implementation of ObservableCollaborativeTransport.subscribeRecovery
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:209

subscribeState

subscribeState(listener: TransportStateListener): () => void
Parameters
- listener: TransportStateListener
Returns () => void
Implementation of ObservableCollaborativeTransport.subscribeState
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/transport/src/websocket-transport.ts:204