Skip to content

Commit

Permalink
Update doc comments on service-connection-provider.ts
Browse files Browse the repository at this point in the history
Add some documentation to make the usage of the local/remote service id's more understandable.

contributed on behalf of STMicroelectronics
  • Loading branch information
tsmaeder authored Jun 12, 2024
1 parent 8d2d0c6 commit 1343218
Showing 1 changed file with 15 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,29 @@ import { ChannelMultiplexer } from '../../common/message-rpc/channel';
import { Deferred } from '../../common/promise-util';
import { ConnectionSource } from './connection-source';

/**
* Service id for the local connection provider
*/
export const LocalConnectionProvider = Symbol('LocalConnectionProvider');
/**
* Service id for the remote connection provider
*/
export const RemoteConnectionProvider = Symbol('RemoteConnectionProvider');

export namespace ServiceConnectionProvider {
export type ConnectionHandler = (path: String, channel: Channel) => void;
}

/**
* This class manages the channels for remote services in the back end
* This class manages the channels for remote services in the back end.
*
* Since we have the ability to use a remote back end via SSH, we need to distinguish
* between two types of services: those that will be redirected to the remote back end
* and those which must remain in the local back end. For example the service that manages
* the remote ssh connections and port forwarding to the remote instance must remain local
* while e.g. the file system service will run in the remote back end. For each set
* of services, we will bind an instance of this class to {@linkcode LocalConnectionProvider}
* and {@linkcode RemoteConnectionProvider} respectively.
*/
@injectable()
export class ServiceConnectionProvider {
Expand Down

0 comments on commit 1343218

Please sign in to comment.