Class TaskServerImpl

Implements

Constructors

constructor

new TaskServerImpl(): TaskServerImpl
Returns TaskServerImpl

Properties

`Protected` `Readonly`backgroundTaskStatusMap

backgroundTaskStatusMap: Map<number, { isActive: boolean }> = ...

Currently there is only one property ('isActive'), but in the future we may want to store more properties

`Protected`clients

clients: TaskClient[] = []

Task clients, to send notifications-to.

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`runnerRegistry

runnerRegistry: TaskRunnerRegistry

`Protected` `Readonly`taskManager

taskManager: TaskManager

`Protected` `Readonly`toDispose

toDispose: Map<number, DisposableCollection> = ...

Map of task id and task disposable

Methods

customExecutionComplete

customExecutionComplete(id: number, exitCode: undefined | number): Promise<void>
plugin callback task complete
Parameters
- id: number
- exitCode: undefined | number
Returns Promise<void>
Implementation of TaskServer.customExecutionComplete
- Defined in packages/task/src/node/task-server.ts:174

disconnectClient

disconnectClient(client: TaskClient): void
Removes a client, from this server
Parameters
- client: TaskClient
Returns void
Implementation of TaskServer.disconnectClient
- Defined in packages/task/src/node/task-server.ts:234

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in packages/task/src/node/task-server.ts:60

`Protected`disposeByTaskId

disposeByTaskId(taskId: number): void
Parameters
- taskId: number
Returns void
- Defined in packages/task/src/node/task-server.ts:68

`Protected`fireBackgroundTaskEndedEvent

fireBackgroundTaskEndedEvent(event: BackgroundTaskEndedEvent): void
Parameters
- event: BackgroundTaskEndedEvent
Returns void
- Defined in packages/task/src/node/task-server.ts:211

`Protected`fireTaskCreatedEvent

fireTaskCreatedEvent(event: TaskInfo, task?: Task): void
Parameters
- event: TaskInfo
- Optionaltask: Task
Returns void
- Defined in packages/task/src/node/task-server.ts:193

`Protected`fireTaskExitedEvent

fireTaskExitedEvent(event: TaskExitedEvent, task?: Task): void
Parameters
- event: TaskExitedEvent
- Optionaltask: Task
Returns void
- Defined in packages/task/src/node/task-server.ts:179

`Protected`fireTaskOutputProcessedEvent

fireTaskOutputProcessedEvent(event: TaskOutputProcessedEvent): void
Parameters
- event: TaskOutputProcessedEvent
Returns void
- Defined in packages/task/src/node/task-server.ts:207

getRegisteredTaskTypes

getRegisteredTaskTypes(): Promise<string[]>
Returns the list of default and registered task runners

Returns Promise<string[]>
Implementation of TaskServer.getRegisteredTaskTypes
- Defined in packages/task/src/node/task-server.ts:170

getTasks

getTasks(context?: string): Promise<TaskInfo[]>
Returns a list of currently running tasks. If a context is provided, only the tasks started in that context will be provided. Using an undefined context matches all tasks, no matter the creation context.
Parameters
- Optionalcontext: string
Returns Promise<TaskInfo[]>
Implementation of TaskServer.getTasks
- Defined in packages/task/src/node/task-server.ts:79

kill

kill(id: number): Promise<void>
Kill task for a given id. Rejects if task is not found
Parameters
- id: number
Returns Promise<void>
Implementation of TaskServer.kill
- Defined in packages/task/src/node/task-server.ts:216

run

run(
    taskConfiguration: TaskConfiguration,
    ctx?: string,
    option?: RunTaskOption,
): Promise<TaskInfo>
Run a task. Optionally pass a context.
Parameters
- taskConfiguration: TaskConfiguration
- Optionalctx: string
- Optionaloption: RunTaskOption
Returns Promise<TaskInfo>
Implementation of TaskServer.run
- Defined in packages/task/src/node/task-server.ts:92

setClient

setClient(client: TaskClient): void
Adds a client to this server
Parameters
- client: TaskClient
Returns void
Implementation of TaskServer.setClient
- Defined in packages/task/src/node/task-server.ts:228