@univerjs/network v0.5.4


Class: WebSocketService

Defined in: submodules/univer/packages/network/src/services/web-socket/web-socket.service.ts:54

This service create a WebSocket connection to a remote server.

Extends

Implements

Constructors

new WebSocketService()

new WebSocketService(): WebSocketService

Returns

WebSocketService

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96

Methods

createSocket()

createSocket(URL): Nullable<ISocket>

Defined in: submodules/univer/packages/network/src/services/web-socket/web-socket.service.ts:55

Parameters

ParameterType
URLstring

Returns

Nullable<ISocket>

Implementation of

ISocketService.createSocket


dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed