danog/code-server
1
0
Fork 0
mirror of https://github.com/danog/code-server.git synced 2024-11-26 20:34:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document client functions

Browse Source
This commit is contained in:
Kyle Carberry 2019-01-13 14:29:33 -06:00
parent d61873e8da
commit da27bc0f04
No known key found for this signature in database
GPG Key ID: A0409BDB6B0B3EDB
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
packages/server/src/browser/client.ts
View File

@ -4,6 +4,9 @@ import { Emitter } from "@coder/events";
import { logger, field } from "@coder/logger"; import { logger, field } from "@coder/logger";
import { ChildProcess, SpawnOptions, ServerProcess } from "./command"; import { ChildProcess, SpawnOptions, ServerProcess } from "./command";
/**
* Client accepts an arbitrary connection intended to communicate with the Server.
*/
export class Client { export class Client {
private evalId: number = 0; private evalId: number = 0;
private evalDoneEmitter: Emitter<EvalDoneMessage> = new Emitter(); private evalDoneEmitter: Emitter<EvalDoneMessage> = new Emitter();
@ -12,6 +15,9 @@ export class Client {
private sessionId: number = 0; private sessionId: number = 0;
private sessions: Map<number, ServerProcess> = new Map(); private sessions: Map<number, ServerProcess> = new Map();
/**
* @param connection Established connection to the server
*/
public constructor( public constructor(
private readonly connection: ReadWriteConnection, private readonly connection: ReadWriteConnection,
) { ) {
@ -31,6 +37,18 @@ export class Client {
public evaluate<R, T1, T2, T3, T4>(func: (a1: T1, a2: T2, a3: T3, a4: T4) => R, a1: T1, a2: T2, a3: T3, a4: T4): Promise<R>; public evaluate<R, T1, T2, T3, T4>(func: (a1: T1, a2: T2, a3: T3, a4: T4) => R, a1: T1, a2: T2, a3: T3, a4: T4): Promise<R>;
public evaluate<R, T1, T2, T3, T4, T5>(func: (a1: T1, a2: T2, a3: T3, a4: T4, a5: T5) => R, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5): Promise<R>; public evaluate<R, T1, T2, T3, T4, T5>(func: (a1: T1, a2: T2, a3: T3, a4: T4, a5: T5) => R, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5): Promise<R>;
public evaluate<R, T1, T2, T3, T4, T5, T6>(func: (a1: T1, a2: T2, a3: T3, a4: T4, a5: T5, a6: T6) => R, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5, a6: T6): Promise<R>; public evaluate<R, T1, T2, T3, T4, T5, T6>(func: (a1: T1, a2: T2, a3: T3, a4: T4, a5: T5, a6: T6) => R, a1: T1, a2: T2, a3: T3, a4: T4, a5: T5, a6: T6): Promise<R>;
/**
* Evaluates a function on the server.
* To pass variables, ensure they are serializable and passed through the included function.
* @example
* const returned = await this.client.evaluate((value) => {
* return value;
* }, "hi");
* console.log(returned);
* // output: "hi"
* @param func Function to evaluate
* @returns {Promise} Promise rejected or resolved from the evaluated function
*/
public evaluate<R, T1, T2, T3, T4, T5, T6>(func: (a1?: T1, a2?: T2, a3?: T3, a4?: T4, a5?: T5, a6?: T6) => R, a1?: T1, a2?: T2, a3?: T3, a4?: T4, a5?: T5, a6?: T6): Promise<R> { public evaluate<R, T1, T2, T3, T4, T5, T6>(func: (a1?: T1, a2?: T2, a3?: T3, a4?: T4, a5?: T5, a6?: T6) => R, a1?: T1, a2?: T2, a3?: T3, a4?: T4, a5?: T5, a6?: T6): Promise<R> {
const newEval = new NewEvalMessage(); const newEval = new NewEvalMessage();
const id = this.evalId++; const id = this.evalId++;
@ -98,6 +116,10 @@ export class Client {
/** /**
* Spawns a process from a command. _Somewhat_ reflects the "child_process" API. * Spawns a process from a command. _Somewhat_ reflects the "child_process" API.
* @example
* const cp = this.client.spawn("echo", ["test"]);
* cp.stdout.on("data", (data) => console.log(data.toString()));
* cp.on("exit", (code) => console.log("exited with", code));
* @param command * @param command
* @param args Arguments * @param args Arguments
* @param options Options to execute for the command * @param options Options to execute for the command
@ -108,7 +130,7 @@ export class Client {
/** /**
* Fork a module. * Fork a module.
* @param modulePath Path of the module * @param modulePath Path of the module
* @param args Args to add for the module * @param args Args to add for the module
* @param options Options to execute * @param options Options to execute
*/ */
@ -156,6 +178,10 @@ export class Client {
return serverProc; return serverProc;
} }
/**
* Handles a message from the server. All incoming server messages should be
* routed through here.
*/
private handleMessage(message: ServerMessage): void { private handleMessage(message: ServerMessage): void {
if (message.hasEvalDone()) { if (message.hasEvalDone()) {
this.evalDoneEmitter.emit(message.getEvalDone()!); this.evalDoneEmitter.emit(message.getEvalDone()!);