@theia/core/lib/browser/messaging/ws-connection-provider.d.ts

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

import { interfaces } from 'inversify';
import { RpcProxy, Emitter, Event, Channel } from '../../common';
import { Endpoint } from '../endpoint';
import { AbstractConnectionProvider } from '../../common/messaging/abstract-connection-provider';
import { Socket } from 'socket.io-client';
import { IWebSocket } from '../../common/messaging/web-socket-channel';
export declare const LocalWebSocketConnectionProvider: unique symbol;
export interface WebSocketOptions {
    /**
     * True by default.
     */
    reconnecting?: boolean;
}
export declare class WebSocketConnectionProvider extends AbstractConnectionProvider<WebSocketOptions> {
    protected readonly onSocketDidOpenEmitter: Emitter<void>;
    get onSocketDidOpen(): Event<void>;
    protected readonly onSocketDidCloseEmitter: Emitter<void>;
    get onSocketDidClose(): Event<void>;
    static createProxy<T extends object>(container: interfaces.Container, path: string, arg?: object): RpcProxy<T>;
    static createLocalProxy<T extends object>(container: interfaces.Container, path: string, arg?: object): RpcProxy<T>;
    static createHandler(container: interfaces.Container, path: string, arg?: object): void;
    protected readonly socket: Socket;
    constructor();
    protected createMainChannel(): Channel;
    protected toIWebSocket(socket: Socket): IWebSocket;
    openChannel(path: string, handler: (channel: Channel) => void, options?: WebSocketOptions): Promise<void>;
    /**
     * @param path The handler to reach in the backend.
     */
    protected createWebSocketUrl(path: string): string;
    protected createHttpWebSocketUrl(path: string): string;
    protected createEndpoint(path: string): Endpoint;
    /**
     * Creates a web socket for the given url
     */
    protected createWebSocket(url: string): Socket;
    /**
     * Path for Socket.io to make its requests to.
     */
    protected createSocketIoPath(url: string): string | undefined;
    protected fireSocketDidOpen(): void;
    protected fireSocketDidClose(): void;
}
//# sourceMappingURL=ws-connection-provider.d.ts.map