package waterfall

Get desktop application:
View/edit binary Protocol Buffers messages

PortForwarder service runs a port forwarding session via waterfall. It allows start and stop forwarding connections when the waterfall client is unable to mantains any state (e.g. the waterfall adb binary).

• rpc ForwardPort (PortForwardRequest, google.protobuf.Empty)

  waterfall.proto:150

• rpc List (google.protobuf.Empty, ForwardedSessions)

  waterfall.proto:153

  message ForwardedSessions

  waterfall.proto:142

  • repeated ForwardSession sessions = 1

• rpc Stop (PortForwardRequest, google.protobuf.Empty)

  waterfall.proto:151

• rpc StopAll (google.protobuf.Empty, google.protobuf.Empty)

  waterfall.proto:152

• rpc Echo (stream Message, stream Message)

  waterfall.proto:112

  Echo exists solely for test purposes.

  message Message

  waterfall.proto:24

  • bytes payload = 1

• rpc Exec (stream CmdProgress, stream CmdProgress)

  waterfall.proto:123

  Exec executes cmd in the device and forward stdout and stderr to client Exec expects a single initial CmdProgress message if stdin is not being redirected. Otherwise Exec will read std from the stream.

  message CmdProgress

  waterfall.proto:65

  • optional Cmd cmd = 5

    Command to execute. Only valid for the initial message of the stream.

  • uint32 exit_code = 1

    the exit code of the command. Only populated when the gRPC stream is done. I.e. the last message before the EOF.

  • bytes stdout = 2

  • bytes stderr = 3

  • bytes stdin = 4

• rpc Forward (stream ForwardMessage, stream ForwardMessage)

  waterfall.proto:126

  Forward forwards the stream payload to the requested socket

  message ForwardMessage

  waterfall.proto:80

  • ForwardMessage.Kind kind = 1

    Kind of connection to start (tcp|udp|unix)

  • ForwardMessage.Op op = 2

  • string addr = 3

    Address to open and redirect payload to.

  • bytes payload = 4

    Data to be pushed to connection established on addr.

  • bool rebind = 5

    Whether or not to rebind the port.

• rpc Pull (Transfer, stream Transfer)

  waterfall.proto:118

  Pull file/dir from device to host.

• rpc Push (stream Transfer, Transfer)

  waterfall.proto:115

  Push file/dir from host to device.

• rpc Version (google.protobuf.Empty, VersionMessage)

  waterfall.proto:129

  Version gets the version of the server.

  message VersionMessage

  waterfall.proto:106

  • string version = 1

Used in: CmdProgress

• string path = 1

  Path to the binary to execute. Path should be absolute. Otherwise behavior is not specified. use /system/bin/sh -c to run in a shell. Interactive shell is not supported.

• repeated string args = 2

  Args to pass to the command

• string dir = 3

  Directory to execute the command

• bool pipeIn = 4

  Whether to pipe stdin to the command

• map<string, string> env = 5

  Environment to use

Used in: ForwardMessage

• UNSET = 0

• TCP = 1

• UDP = 2

• UNIX = 3

Used in: ForwardMessage

• OPEN = 0

• FWD = 1

• CLOSE = 2

Used in: ForwardedSessions, PortForwardRequest

• string src = 1

• string dst = 2

Used as request type in: PortForwarder.ForwardPort, PortForwarder.Stop

• bool rebind = 3

• optional ForwardSession session = 4

Keep this as lean as possible. We only care about the payload during most of the duration of the session. All other fields are only useful during the beginning/end of the transfer

Used as request type in: Waterfall.Pull, Waterfall.Push

Used as response type in: Waterfall.Pull, Waterfall.Push

• string path = 1

  Remote path to for push/pull. Remote path lives in the server fs. There is no need to send local path, since client has this info.

• bytes payload = 2

  A stream of bytes. Encoded as a tarball.

• bool success = 3

  status fields.

• bytes err = 4