src/vs/platform/remote/common/remoteSocketFactoryService.ts
60 LOC · 39 covered · 21 uncovered · 5 ranges · 7 concepts · 1 introducers · 6 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
remoteAgentConnection.ts ×53
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { IDisposable, toDisposable } from '../../../base/common/lifecycle.js';
import { ISocket } from '../../../base/parts/ipc/common/ipc.net.js';
import { createDecorator } from '../../instantiation/common/instantiation.js';
import { RemoteConnectionOfType, RemoteConnectionType, RemoteConnection } from './remoteAuthorityResolver.js';
export const IRemoteSocketFactoryService = createDecorator<IRemoteSocketFactoryService>('remoteSocketFactoryService');
export interface IRemoteSocketFactoryService {
readonly _serviceBrand: undefined;
/**
* Register a socket factory for the given message passing type
* @param type passing type to register for
* @param factory function that returns the socket factory, or undefined if
* it can't handle the data.
*/
register<T extends RemoteConnectionType>(type: T, factory: ISocketFactory<T>): IDisposable;
connect(connectTo: RemoteConnection, path: string, query: string, debugLabel: string): Promise<ISocket>;
}
export interface ISocketFactory<T extends RemoteConnectionType> {
supports(connectTo: RemoteConnectionOfType<T>): boolean;
connect(connectTo: RemoteConnectionOfType<T>, path: string, query: string, debugLabel: string): Promise<ISocket>;
}
export class RemoteSocketFactoryService implements IRemoteSocketFactoryService {
declare readonly _serviceBrand: undefined;
private readonly factories: { [T in RemoteConnectionType]?: ISocketFactory<T>[] } = {};
public register<T extends RemoteConnectionType>(type: T, factory: ISocketFactory<T>): IDisposable {
this.factories[type] ??= [];
this.factories[type]!.push(factory);
return toDisposable(() => {
const idx = this.factories[type]?.indexOf(factory);
if (typeof idx === 'number' && idx >= 0) {
this.factories[type]?.splice(idx, 1);
}
});
}
private getSocketFactory<T extends RemoteConnectionType>(messagePassing: RemoteConnectionOfType<T>): ISocketFactory<T> | undefined {
const factories = (this.factories[messagePassing.type] || []);
return factories.find(factory => factory.supports(messagePassing));
}
public connect(connectTo: RemoteConnection, path: string, query: string, debugLabel: string): Promise<ISocket> {
const socketFactory = this.getSocketFactory(connectTo);
if (!socketFactory) {
throw new Error(`No socket factory found for ${connectTo}`);
}
return socketFactory.connect(connectTo, path, query, debugLabel);
}