@univerjs/network v0.1.17 • Docs
Class: WebSocketService
This service create a WebSocket connection to a remote server.
Extends
Implements
Constructors
new WebSocketService()
new WebSocketService(): WebSocketServiceReturns
Inherited from
Properties
| Property | Modifier | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable._disposed | packages/core/src/shared/lifecycle.ts:93 (opens in a new tab) |
Methods
createSocket()
createSocket(URL): Nullable<ISocket>Parameters
| Parameter | Type |
|---|---|
URL | string |
Returns
Implementation of
Defined in
packages/network/src/services/web-socket/web-socket.service.ts:56 (opens in a new tab)
dispose()
dispose(): voidReturns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)
disposeWithMe()
protected disposeWithMe(disposable): IDisposableParameters
| Parameter | Type |
|---|---|
disposable | DisposableLike |
Returns
IDisposable
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)
ensureNotDisposed()
protected ensureNotDisposed(): voidReturns
void
Inherited from
Defined in
packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)