Class BaseTerminalServer`Abstract`

Hierarchy (View Summary)

BaseTerminalServer
- ShellTerminalServer
- TerminalServer

Implements

IBaseTerminalServer

Index

Constructors

Properties

client logger processManager terminalToDispose

Methods

attach close create dispose getCwdURI getDefaultShell getProcessId getProcessInfo notifyClientOnExit onAttachAttempted postAttachAttempted postCreate resize setClient

Constructors

constructor

new BaseTerminalServer(
processManager: ProcessManager,
logger: ILogger,
): BaseTerminalServer
Parameters
- processManager: ProcessManager
- logger: ILogger
Returns BaseTerminalServer
- Defined in packages/terminal/src/node/base-terminal-server.ts:34

Properties

`Protected`client

client: undefined | IBaseTerminalClient = undefined

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`processManager

processManager: ProcessManager

`Protected`terminalToDispose

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

Methods

attach

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

close

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

`Abstract`create

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

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of IBaseTerminalServer.dispose
- Defined in packages/terminal/src/node/base-terminal-server.ts:113

getCwdURI

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

getDefaultShell

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

getProcessId

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

getProcessInfo

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

`Protected`notifyClientOnExit

notifyClientOnExit(term: TerminalProcess): DisposableCollection
Parameters
- term: TerminalProcess
Returns DisposableCollection
- Defined in packages/terminal/src/node/base-terminal-server.ts:135

onAttachAttempted

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

`Protected`postAttachAttempted

postAttachAttempted(term: TaskTerminalProcess): void
Parameters
- term: TaskTerminalProcess
Returns void
- Defined in packages/terminal/src/node/base-terminal-server.ts:169

`Protected`postCreate

postCreate(term: TerminalProcess): void
Parameters
- term: TerminalProcess
Returns void
- Defined in packages/terminal/src/node/base-terminal-server.ts:164

resize

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

setClient

setClient(client: undefined | IBaseTerminalClient): void
Set the client to receive notifications on.
Parameters
- client: undefined | IBaseTerminalClient
Returns void
Implementation of IBaseTerminalServer.setClient
- Defined in packages/terminal/src/node/base-terminal-server.ts:127