Class RemoteDockerContainerConnection

constructor

• new RemoteDockerContainerConnection(
      options: RemoteContainerConnectionOptions,
  ): RemoteDockerContainerConnection

  Parameters

  • options: RemoteContainerConnectionOptions

  Returns RemoteDockerContainerConnection

container

docker

id

localPort

name

onDidDisconnect

remotePort

remoteSetupResult

type

copy

• copy(
      localPath: string | Buffer | ReadableStream,
      remotePath: string,
  ): Promise<void>

  copy files from local to remote

  Parameters

  • localPath: string | Buffer | ReadableStream
  • remotePath: string

  Returns Promise<void>

dispose

• dispose(): Promise<void>

  Dispose this object.

  Returns Promise<void>

disposeSync

• disposeSync(): void

  used for disposing when theia is shutting down

  Returns void

exec

• exec(
      cmd: string,
      args?: string[],
      options?: RemoteExecOptions,
  ): Promise<RemoteExecResult>

  execute a single command on the remote machine

  Parameters

  • cmd: string
  • Optionalargs: string[]
  • Optionaloptions: RemoteExecOptions

  Returns Promise<RemoteExecResult>

execPartial

• execPartial(
      cmd: string,
      tester: RemoteExecTester,
      args?: string[],
      options?: RemoteExecOptions,
  ): Promise<RemoteExecResult>

  execute a command on the remote machine and wait for a specific output

  Parameters

  • cmd: string
  • tester: RemoteExecTester

    function which returns true if the output is as expected

  • Optionalargs: string[]
  • Optionaloptions: RemoteExecOptions

  Returns Promise<RemoteExecResult>

forwardOut

• forwardOut(socket: Socket, port?: number): Promise<void>

  Parameters

  • socket: Socket
  • Optionalport: number

  Returns Promise<void>

getDockerHost

• getDockerHost(): string

  Returns string