Class FrontendConnectionStatusService

Hierarchy (View Summary)

AbstractConnectionStatusService
- FrontendConnectionStatusService

Index

Constructors

Properties

connectionStatus logger options pingService statusChangeEmitter wsConnectionProvider

Accessors

currentStatus onStatusChange

Methods

clearTimeout dispose fireStatusChange init performPingRequest schedulePing setTimeout updateStatus

Constructors

constructor

new FrontendConnectionStatusService(
options?: ConnectionStatusOptions,
): FrontendConnectionStatusService
Parameters
- options: ConnectionStatusOptions = ConnectionStatusOptions.DEFAULT
Returns FrontendConnectionStatusService
Inherited from AbstractConnectionStatusService.constructor
- Defined in packages/core/src/browser/connection-status-service.ts:88

Properties

`Protected`connectionStatus

connectionStatus: ConnectionStatus = ConnectionStatus.ONLINE

`Protected`logger

logger: ILogger

`Protected` `Readonly`options

options: ConnectionStatusOptions = ConnectionStatusOptions.DEFAULT

`Protected` `Readonly`pingService

pingService: PingService

`Protected` `Readonly`statusChangeEmitter

statusChangeEmitter: Emitter<ConnectionStatus> = ...

`Protected` `Readonly`wsConnectionProvider

wsConnectionProvider: WebSocketConnectionSource

Accessors

currentStatus

get currentStatus(): ConnectionStatus
The actual connection status.

Returns ConnectionStatus
Inherited from AbstractConnectionStatusService.currentStatus
- Defined in packages/core/src/browser/connection-status-service.ts:94

onStatusChange

get onStatusChange(): Event<ConnectionStatus>
Clients can listen on connection status change events.

Returns Event<ConnectionStatus>
Inherited from AbstractConnectionStatusService.onStatusChange
- Defined in packages/core/src/browser/connection-status-service.ts:90

Methods

`Protected`clearTimeout

clearTimeout(handle?: number): void
Parameters
- Optionalhandle: number
Returns void
- Defined in packages/core/src/browser/connection-status-service.ts:165

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from AbstractConnectionStatusService.dispose
- Defined in packages/core/src/browser/connection-status-service.ts:98

`Protected`fireStatusChange

fireStatusChange(status: ConnectionStatus): void
Parameters
- status: ConnectionStatus
Returns void
Inherited from AbstractConnectionStatusService.fireStatusChange
- Defined in packages/core/src/browser/connection-status-service.ts:111

`Protected`init

init(): void
Returns void
- Defined in packages/core/src/browser/connection-status-service.ts:126

`Protected`performPingRequest

performPingRequest(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/browser/connection-status-service.ts:150

`Protected`schedulePing

schedulePing(): void
Returns void
- Defined in packages/core/src/browser/connection-status-service.ts:142

`Protected`setTimeout

setTimeout(handler: (...args: any[]) => void, timeout: number): number
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- handler: (...args: any[]) => void
- timeout: number
Returns number
- Defined in packages/core/src/browser/connection-status-service.ts:161

`Protected`updateStatus

updateStatus(success: boolean): void
Parameters
- success: boolean
Returns void
Inherited from AbstractConnectionStatusService.updateStatus
- Defined in packages/core/src/browser/connection-status-service.ts:102