@theia/core/lib/browser/connection-status-service.d.ts

Theia is a cloud & desktop IDE framework implemented in TypeScript.

import { ILogger } from '../common/logger';
import { Event, Emitter } from '../common/event';
import { DefaultFrontendApplicationContribution } from './frontend-application';
import { StatusBar } from './status-bar/status-bar';
import { WebSocketConnectionProvider } from './messaging/ws-connection-provider';
import { Disposable, DisposableCollection } from '../common';
/**
 * Service for listening on backend connection changes.
 */
export declare const ConnectionStatusService: unique symbol;
export interface ConnectionStatusService {
    /**
     * The actual connection status.
     */
    readonly currentStatus: ConnectionStatus;
    /**
     * Clients can listen on connection status change events.
     */
    readonly onStatusChange: Event<ConnectionStatus>;
}
/**
 * The connection status.
 */
export declare enum ConnectionStatus {
    /**
     * Connected to the backend.
     */
    ONLINE = 0,
    /**
     * The connection is lost between frontend and backend.
     */
    OFFLINE = 1
}
export declare class ConnectionStatusOptions {
    static DEFAULT: ConnectionStatusOptions;
    /**
     * Timeout in milliseconds before the application is considered offline. Must be a positive integer.
     */
    readonly offlineTimeout: number;
}
export declare const PingService: unique symbol;
export interface PingService {
    ping(): Promise<void>;
}
export declare abstract class AbstractConnectionStatusService implements ConnectionStatusService, Disposable {
    protected readonly options: ConnectionStatusOptions;
    protected readonly statusChangeEmitter: Emitter<ConnectionStatus>;
    protected connectionStatus: ConnectionStatus;
    protected logger: ILogger;
    constructor(options?: ConnectionStatusOptions);
    get onStatusChange(): Event<ConnectionStatus>;
    get currentStatus(): ConnectionStatus;
    dispose(): void;
    protected updateStatus(success: boolean): void;
    protected fireStatusChange(status: ConnectionStatus): void;
}
export declare class FrontendConnectionStatusService extends AbstractConnectionStatusService {
    private scheduledPing;
    protected readonly wsConnectionProvider: WebSocketConnectionProvider;
    protected readonly pingService: PingService;
    protected init(): void;
    protected schedulePing(): void;
    protected performPingRequest(): Promise<void>;
    protected setTimeout(handler: (...args: any[]) => void, timeout: number): number;
    protected clearTimeout(handle?: number): void;
}
export declare class ApplicationConnectionStatusContribution extends DefaultFrontendApplicationContribution {
    protected readonly connectionStatusService: ConnectionStatusService;
    protected readonly statusBar: StatusBar;
    protected readonly logger: ILogger;
    protected readonly toDisposeOnOnline: DisposableCollection;
    constructor(connectionStatusService: ConnectionStatusService, statusBar: StatusBar, logger: ILogger);
    protected onStateChange(state: ConnectionStatus): void;
    private statusbarId;
    protected handleOnline(): void;
    protected handleOffline(): void;
}
//# sourceMappingURL=connection-status-service.d.ts.map