From 816606be18b06140a2c267ae77b48a8fe9090148 Mon Sep 17 00:00:00 2001 From: jbhusson <jonah@elixxir.io> Date: Tue, 13 Sep 2022 13:53:54 -0400 Subject: [PATCH] Improve comments to specify how period is formatted --- bindings/fileTransfer.go | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/bindings/fileTransfer.go b/bindings/fileTransfer.go index b2239b9c8..4c3c05a4b 100644 --- a/bindings/fileTransfer.go +++ b/bindings/fileTransfer.go @@ -268,7 +268,10 @@ func (f *FileTransfer) CloseSend(tidBytes []byte) error { // Parameters: // - tidBytes - file transfer ID // - callback - callback that reports file reception progress -// - period - duration to wait between progress callbacks triggering +// - period - duration to wait between progress callbacks triggering, +// formatted as a string containing a decimal number followed by unit +// specification such as "300ms", "-1.5h" or "2h45m". +// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". func (f *FileTransfer) RegisterSentProgressCallback(tidBytes []byte, callback FileTransferSentProgressCallback, period string) error { cb := func(completed bool, arrived, total uint16, @@ -299,7 +302,10 @@ func (f *FileTransfer) RegisterSentProgressCallback(tidBytes []byte, // Parameters: // - tidBytes - file transfer ID // - callback - callback that reports file reception progress -// - period - duration to wait between progress callbacks triggering +// - period - duration to wait between progress callbacks triggering, +// formatted as a string containing a decimal number followed by unit +// specification such as "300ms", "-1.5h" or "2h45m". +// Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". func (f *FileTransfer) RegisterReceivedProgressCallback(tidBytes []byte, callback FileTransferReceiveProgressCallback, period string) error { cb := func(completed bool, received, total uint16, -- GitLab