package fkie_multimaster_msgs.file

Get desktop application:
View/edit binary Protocol Buffers messages

* The file manager service definition.

• rpc GetFileContent (GetFileContentRequest, stream GetFileContentReply)

  file.proto:39

  message GetFileContentRequest

  file.proto:55

  * The request message to get the content of a file.

  • string path = 1

  message GetFileContentReply

  file.proto:63

  * The reply message with status and file content on success. :param status: errors if occurred. :param file: file content

  • optional ReturnStatus status = 1

  • optional FileChunk file = 2

• rpc SaveFileContent (stream SaveFileContentRequest, stream SaveFileContentReply)

  file.proto:40

  message SaveFileContentRequest

  file.proto:77

  * Request to save the file content. :param overwrite: force replace of existing file with new content. :param file: new file content

  • bool overwrite = 1

  • optional FileChunk file = 2

  message SaveFileContentReply

  file.proto:86

  * The reply message with status and new modification time on success. :param status: errors if occurred. :param ack: acknowledge for received chunks.

  • optional ReturnStatus status = 1

  • optional FileChunkAck ack = 2

• rpc CopyFileTo (CopyToRequest, ReturnStatus)

  file.proto:41

  message CopyToRequest

  file.proto:96

  * The message to transfer file to another grpc server. :param path: the path of the file. :param uri: the uri of the another server :param overwrite: force replace of existing file with new content or create a new file

  • string path = 1

  • string uri = 2

  • bool overwrite = 3

• rpc Rename (RenameRequest, ReturnStatus)

  file.proto:42

  message RenameRequest

  file.proto:68

  • string old = 1

  • string new = 2

• rpc ListPath (ListPathRequest, ListPathReply)

  file.proto:43

  message ListPathRequest

  file.proto:134

  * The request message to list the content in given path. :param path: if path is empty the root paths specified in ROS_PACKAGE_PATH.

  • string path = 1

  message ListPathReply

  file.proto:142

  * The response message with status and list of files in requested path on success. :param status: status of the request process. :param path: requested path. :param items: list of files. If the status is not OK the list is empty.

  • optional ReturnStatus status = 1

  • string path = 2

  • repeated PathObj items = 3

• rpc ListPackages (ListPackagesRequest, ListPackagesReply)

  file.proto:44

  message ListPackagesRequest

  file.proto:188

  * The request message to list all ROS packages in given path. :param clear_ros_cache: clear ROS cache.

  • bool clear_ros_cache = 1

  message ListPackagesReply

  file.proto:195

  * The response message with status and list of packages on success. :param status: status of the request process. :param items: list of packages. If the status is not OK the list is empty.

  • optional ReturnStatus status = 1

  • repeated PackageObj items = 2

• rpc ChangedFiles (PathList, PathList)

  file.proto:45

• rpc GetPackageBinaries (PackageObj, PathList)

  file.proto:46

• rpc Delete (PathObj, ReturnStatus)

  file.proto:47

• rpc New (PathObj, ReturnStatus)

  file.proto:48

(message has no fields)

* The message to transfer the file content. :param path: the path of the file. Required on first chunk. :param mtime: time of last modification of this file. If save the content, the time should be equal to the file already exists (zero for new file). Required on first chunk. :param size: size of the file in bytes. :param offset: offset of data in this chunk. :param data: file content. :param package: if package name is set the path is handled as relative to the package.

Used in: GetFileContentReply, SaveFileContentRequest

• string path = 1

• double mtime = 2

• uint64 size = 3

• uint64 offset = 4

• bytes data = 5

• string package = 6

* The acknowledge for received chunk. :param path: the path of the file. Only on first chunk. :param mtime: time of last modification of this file. Only valid for last chunk. :param size: current received data.

Used in: SaveFileContentReply

• string path = 1

• double mtime = 2

• uint64 size = 4

Used as request type in: FileService.GetPackageBinaries

Used as field type in: ListPackagesReply

• string name = 1

• string path = 2

* This message is used to request and reply for changed files. :param items: list of files.

Used as request type in: FileService.ChangedFiles

Used as response type in: FileService.ChangedFiles, FileService.GetPackageBinaries

• repeated PathObj items = 1

Used as request type in: FileService.Delete, FileService.New

Used as field type in: ListPathReply, PathList

• string path = 1

• double mtime = 2

  time of last modification of path. The return value is a number giving the number of seconds since the epoch

• uint64 size = 3

  size, in bytes, of path

• PathObj.PathType type = 4

Used in: PathObj

• FILE = 0

• DIR = 1

• SYMLINK = 2

• PACKAGE = 3

* The status message included in replies.

Used as response type in: FileService.CopyFileTo, FileService.Delete, FileService.New, FileService.Rename

Used as field type in: GetFileContentReply, ListPackagesReply, ListPathReply, SaveFileContentReply

• sint32 code = 1

• sint32 error_code = 2

• string error_msg = 3

• string error_file = 4

• OK = 0

• ERROR = 1

• IO_ERROR = 2

• OS_ERROR = 3

• CHANGED_FILE = 4

• REMOVED_FILE = 5