SHIPHarbour:Files:Receive

Source File

SHIPHarbour_Files.proto

Description

These messages are used to download any arbitrary file from a Serious Integrated module. File transfers will result in multiple messages between SHIPHarbour Master and the client. The client must first request the file be downloaded and then SHIPHarbour Master will generate response messages of this same type to inform the client of the progress and data being downloaded from the module.

Message Fields

Initial Message Fields

These fields are required in the first message to request the start of the routine execution.

filesystem

An FSType indicating what kind of file system should be accessed.

instance

A number indicating exactly which file system should be accessed.

filepath

The complete source file path starting from the root directory.

NOTE: As of the writing of this document, only 8.3 filenames in the root directory are supported by Serious Integrated modules.

interval

The minimum number of milliseconds between responses to the request describing the progress of the operation.

---

Response Message Fields

These fields will be used by SHIPHarbour Master to notify the client of the progress of the operation.

fileData

Byte buffer containing the file data for the file being downloaded from a Serious Integrated module.

current

A number indicating the current progress as compared to the field total.

total

A number indicating the value that current must match before this operation is complete.