Package com.viam.service.shell.v1

Interface ShellServiceGrpc.AsyncService

All Known Implementing Classes:
ShellServiceGrpc.ShellServiceImplBase
Enclosing class:
ShellServiceGrpc
public static interface ShellServiceGrpc.AsyncService
 A ShellService service allows access to an interactive shell experience, including
 utilities commonly found in tandem with other secure shells.

  • Method Details

    • shell

      default io.grpc.stub.StreamObserver<Shell.ShellRequest> shell(io.grpc.stub.StreamObserver<Shell.ShellResponse> responseObserver)
       Shell starts a shell with an input and output pipe.

    • copyFilesToMachine

      default io.grpc.stub.StreamObserver<Shell.CopyFilesToMachineRequest> copyFilesToMachine(io.grpc.stub.StreamObserver<Shell.CopyFilesToMachineResponse> responseObserver)
       CopyFilesToMachines copies a stream of files from a client to the connected-to machine.
 Initially, metadata is sent to describe the destination in the filesystem in addition
 to what kind of file(s) are being sent.
 Once metadata is sent, the file transfer can proceed where one-by-one, file data is sent
 until EOF per file.
 After each file is sent, the machine must respond with an ACK before the next file can
 be sent. This provides back-pressure and ordering.
 The order in which individual files are sent does not matter; that is, if traversing a
 directory, copying depth-first, breadth-first, or any other algorithm does not matter.
 Permissions and metadata on files copied are only preserved if the preserve option is
 set in the initial request metadata.

    • copyFilesFromMachine

      default io.grpc.stub.StreamObserver<Shell.CopyFilesFromMachineRequest> copyFilesFromMachine(io.grpc.stub.StreamObserver<Shell.CopyFilesFromMachineResponse> responseObserver)
       CopyFilesFromMachine copies a stream of files from a connected-to machine to the calling client.
 Essentially, it is the inverse of CopyFilesToMachine with the same ACK mechanism in reverse.
 The initial metadata request will request the paths to copy along with if permissions should
 be preserved (and consequently sent over the wire).

    • doCommand

      default void doCommand(Common.DoCommandRequest request, io.grpc.stub.StreamObserver<Common.DoCommandResponse> responseObserver)
       DoCommand sends/receives arbitrary commands