Class BaseTerminalServer

Hierarchy

BaseTerminalServer
- ShellTerminalServer
- TerminalServer

Implements

IBaseTerminalServer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseTerminalServer(processManager: ProcessManager, logger: ILogger): BaseTerminalServer

- Defined in packages/terminal/src/node/base-terminal-server.ts:42
Parameters
- processManager: ProcessManager
- logger: ILogger
Returns BaseTerminalServer

Properties

Protected client

client: undefined | IBaseTerminalClient = ...

Readonly collections

collections: Map<string, EnvironmentVariableCollectionWithPersistence> = ...

Gets a single collection constructed by merging all environment variable collections into one.

Protected Readonly logger

logger: ILogger

mergedCollection

mergedCollection: MergedEnvironmentVariableCollection

Gets a single collection constructed by merging all environment variable collections into one.

Protected Readonly processManager

processManager: ProcessManager

Protected terminalToDispose

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

Methods

attach

attach(id: number): Promise<number>

Implementation of IBaseTerminalServer.attach
- Defined in packages/terminal/src/node/base-terminal-server.ts:60
Parameters
- id: number
Returns Promise<number>

close

close(id: number): Promise<void>

Implementation of IBaseTerminalServer.close
- Defined in packages/terminal/src/node/base-terminal-server.ts:110
Parameters
- id: number
Returns Promise<void>

Abstract create

create(options: IBaseTerminalServerOptions): Promise<number>

Implementation of IBaseTerminalServer.create
- Defined in packages/terminal/src/node/base-terminal-server.ts:58
Parameters
- options: IBaseTerminalServerOptions
Returns Promise<number>

deleteCollection

deleteCollection(extensionIdentifier: string): void

Implementation of IBaseTerminalServer.deleteCollection
- Defined in packages/terminal/src/node/base-terminal-server.ts:183
Deletes an extension's environment variable collection.

Parameters
- extensionIdentifier: string
Returns void

dispose

dispose(): void

Implementation of IBaseTerminalServer.dispose
- Defined in packages/terminal/src/node/base-terminal-server.ts:122
Dispose this object.

Returns void

getCwdURI

getCwdURI(id: number): Promise<string>

Implementation of IBaseTerminalServer.getCwdURI
- Defined in packages/terminal/src/node/base-terminal-server.ts:102
Parameters
- id: number
Returns Promise<string>

getDefaultShell

getDefaultShell(): Promise<string>

Implementation of IBaseTerminalServer.getDefaultShell
- Defined in packages/terminal/src/node/base-terminal-server.ts:118
Returns Promise<string>

getProcessId

getProcessId(id: number): Promise<number>

Implementation of IBaseTerminalServer.getProcessId
- Defined in packages/terminal/src/node/base-terminal-server.ts:83
Parameters
- id: number
Returns Promise<number>

getProcessInfo

getProcessInfo(id: number): Promise<TerminalProcessInfo>

Implementation of IBaseTerminalServer.getProcessInfo
- Defined in packages/terminal/src/node/base-terminal-server.ts:91
Parameters
- id: number
Returns Promise<TerminalProcessInfo>

onAttachAttempted

onAttachAttempted(id: number): Promise<void>

Implementation of IBaseTerminalServer.onAttachAttempted
- Defined in packages/terminal/src/node/base-terminal-server.ts:71
Parameters
- id: number
Returns Promise<void>

Protected persistCollections

persistCollections(): void

- Defined in packages/terminal/src/node/base-terminal-server.ts:193
Returns void

Protected postCreate

postCreate(term: TerminalProcess): void

- Defined in packages/terminal/src/node/base-terminal-server.ts:144
Parameters
- term: TerminalProcess
Returns void

resize

resize(id: number, cols: number, rows: number): Promise<void>

Implementation of IBaseTerminalServer.resize
- Defined in packages/terminal/src/node/base-terminal-server.ts:126
Parameters
- id: number
- cols: number
- rows: number
Returns Promise<void>

Private resolveMergedCollection

resolveMergedCollection(): MergedEnvironmentVariableCollection

- Defined in packages/terminal/src/node/base-terminal-server.ts:209
Returns MergedEnvironmentVariableCollection

setClient

setClient(client: undefined | IBaseTerminalClient): void

Implementation of IBaseTerminalServer.setClient
- Defined in packages/terminal/src/node/base-terminal-server.ts:136
If this server is a proxy to a remote server then a client is used as a local object to handle JSON-RPC messages from the remote server.

Parameters
- client: undefined | IBaseTerminalClient
Returns void

setCollection

setCollection(extensionIdentifier: string, persistent: boolean, collection: SerializableEnvironmentVariableCollection): void

Implementation of IBaseTerminalServer.setCollection
- Defined in packages/terminal/src/node/base-terminal-server.ts:177
Sets an extension's environment variable collection.

Parameters
- extensionIdentifier: string
- persistent: boolean
- collection: SerializableEnvironmentVariableCollection
Returns void

Private updateCollections

updateCollections(): void

- Defined in packages/terminal/src/node/base-terminal-server.ts:188
Returns void