From 8e4b163a0ab1790e1af2b83ec7953b81e6c223cd Mon Sep 17 00:00:00 2001
From: jbhusson <jonah@elixxir.io>
Date: Tue, 13 Sep 2022 14:30:29 -0400
Subject: [PATCH] Additionaly explanation of period value
---
bindings/fileTransfer.go | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/bindings/fileTransfer.go b/bindings/fileTransfer.go
index 79e4bbb86..a460252a9 100644
--- a/bindings/fileTransfer.go
+++ b/bindings/fileTransfer.go
@@ -268,7 +268,9 @@ func (f *FileTransfer) CloseSend(tidBytes []byte) error {
// Parameters:
// - tidBytes - file transfer ID
// - callback - callback that reports file reception progress
-// - period - duration (in ms) to wait between progress callbacks triggering
+// - period - Duration (in ms) to wait between progress callbacks triggering.
+// This value should depend on how frequently you want to receive
+// updates. Suggested default: 50
func (f *FileTransfer) RegisterSentProgressCallback(tidBytes []byte,
callback FileTransferSentProgressCallback, period int) error {
cb := func(completed bool, arrived, total uint16,
@@ -297,7 +299,8 @@ func (f *FileTransfer) RegisterSentProgressCallback(tidBytes []byte,
// - tidBytes - file transfer ID
// - callback - callback that reports file reception progress
// - period - Duration (in ms) to wait between progress callbacks triggering.
-// Suggested default: 50
+// This value should depend on how frequently you want to receive
+// updates. Suggested default: 50
func (f *FileTransfer) RegisterReceivedProgressCallback(tidBytes []byte,
callback FileTransferReceiveProgressCallback, period int) error {
cb := func(completed bool, received, total uint16,
--
GitLab