Add --file-uplink-chunk-size argument (#273)

Author: jrpear

src/fprime_gds/common/pipeline/files.py

@@ -25,7 +25,7 @@ def __init__(self):
         self.__downlinker = None
 
     def setup_file_handling(
-        self, down_store, file_encoder, file_decoder, distributor, log_dir, cooldown=0.5
+        self, down_store, file_encoder, file_decoder, distributor, log_dir, cooldown=0.5, chunk=256,
     ):
         """
         Sets up the file handling (uplink and downlink) from a pair of encoders and decoders.
@@ -37,8 +37,9 @@ def setup_file_handling(
         :param distributor: data distributor to register handshaking to
         :param log_dir: log directory to output downlink logs
         :param cooldown: cooldown period between uplink packets
+        :param chunk: size of the data payload for a file uplink
         """
-        self.__uplinker = fprime_gds.common.files.uplinker.FileUplinker(file_encoder, cooldown=cooldown)
+        self.__uplinker = fprime_gds.common.files.uplinker.FileUplinker(file_encoder, cooldown=cooldown, chunk=chunk)
         self.__downlinker = fprime_gds.common.files.downlinker.FileDownlinker(
             down_store, log_dir=log_dir
         )

src/fprime_gds/common/pipeline/standard.py

@@ -63,6 +63,7 @@ def setup(
         logging_prefix=None,
         data_logging_enabled=True,
         cooldown=0.5,
+        chunk=256,
     ):
         """
         Setup the standard pipeline for moving data from the middleware layer through the GDS layers using the standard
@@ -74,6 +75,7 @@ def setup(
         :param logging_prefix: logging prefix. Defaults to not logging at all.
         :param packet_spec: location of packetized telemetry XML specification.
         :param cooldown: cooldown period between file uplink packets
+        :param chunk: size of the data payload for a file uplink
         """
         self.distributor = fprime_gds.common.distributor.distributor.Distributor()
         self.client_socket = self.__transport_type()
@@ -99,6 +101,7 @@ def setup(
             self.distributor,
             logging_prefix,
             cooldown=cooldown,
+            chunk=chunk,
         )
         # Register distributor to client socket
         self.client_socket.register(self.distributor)

src/fprime_gds/executables/cli.py

@@ -1091,6 +1091,14 @@ def get_arguments(self) -> Dict[Tuple[str, ...], Dict[str, Any]]:
                 "type": float,
                 "help": "Cooldown period between file uplink packets. Default: %(default)s S",
             },
+            ("--file-uplink-chunk-size",): {
+                "dest": "file_uplink_chunk_size",
+                "action": "store",
+                "default": 256,
+                "required": False,
+                "type": int,
+                "help": "Size of the data payload for a file uplink. Default: %(default)s",
+            },
         }
 
     def handle_arguments(self, args, **kwargs):
@@ -1130,6 +1138,7 @@ def pipeline_factory(args_ns, pipeline=None) -> StandardPipeline:
             "logging_prefix": args_ns.logs,
             "data_logging_enabled": not args_ns.disable_data_logging,
             "cooldown": args_ns.file_uplink_cooldown,
+            "chunk": args_ns.file_uplink_chunk_size,
         }
         pipeline = pipeline if pipeline else StandardPipeline()
         pipeline.transport_implementation = args_ns.connection_transport