From aea77fc292e4a858caf3aba962da6a3dbe4307f9 Mon Sep 17 00:00:00 2001
From: Jono Wenger <jono@elixxir.io>
Date: Mon, 2 May 2022 11:03:57 -0700
Subject: [PATCH] Fix proto generation fiule and add documentation
---
fileTransfer2/e2e/ftMessages.proto | 16 ++++++++--------
fileTransfer2/e2e/generateProto.sh | 2 +-
fileTransfer2/e2e/manager.go | 3 +++
3 files changed, 12 insertions(+), 9 deletions(-)
diff --git a/fileTransfer2/e2e/ftMessages.proto b/fileTransfer2/e2e/ftMessages.proto
index a272b56e8..ede709ac4 100644
--- a/fileTransfer2/e2e/ftMessages.proto
+++ b/fileTransfer2/e2e/ftMessages.proto
@@ -13,12 +13,12 @@ option go_package = "fileTransfer2/e2e";
// NewFileTransfer is transmitted first on the initialization of a file transfer
// to inform the receiver about the incoming file.
message NewFileTransfer {
- string fileName = 1; // Name of the file
- string fileType = 2; // String that indicates type of file
- bytes transferKey = 3; // 256-bit encryption key
- bytes transferMac = 4; // 256-bit MAC of the entire file
- uint32 numParts = 5; // Number of file parts
- uint32 size = 6; // The size of the file, in bytes
- float retry = 7; // Determines how many times to retry sending
- bytes preview = 8; // A preview of the file
+ string fileName = 1; // Name of the file
+ string fileType = 2; // String that indicates type of file
+ bytes transferKey = 3; // 256-bit encryption key
+ bytes transferMac = 4; // 256-bit MAC of the entire file
+ uint32 numParts = 5; // Number of file parts
+ uint32 size = 6; // The size of the file, in bytes
+ float retry = 7; // Determines how many times to retry sending
+ bytes preview = 8; // A preview of the file
}
\ No newline at end of file
diff --git a/fileTransfer2/e2e/generateProto.sh b/fileTransfer2/e2e/generateProto.sh
index 324062a3c..7dacae81b 100644
--- a/fileTransfer2/e2e/generateProto.sh
+++ b/fileTransfer2/e2e/generateProto.sh
@@ -7,4 +7,4 @@
# LICENSE file ///
#
-protoc --go_out=paths=source_relative:. fileTransfer/ftMessages.proto
+protoc --go_out=paths=source_relative:. fileTransfer2/e2e/ftMessages.proto
diff --git a/fileTransfer2/e2e/manager.go b/fileTransfer2/e2e/manager.go
index a778c3e63..2d5e4bcbb 100644
--- a/fileTransfer2/e2e/manager.go
+++ b/fileTransfer2/e2e/manager.go
@@ -28,6 +28,8 @@ const (
errNewFtManager = "cannot create new E2E file transfer manager: %+v"
)
+// manager handles the sending and receiving of file transfers using E2E
+// messages to inform the recipient of incoming file transfers.
type manager struct {
// Callback that is called every time a new file transfer is received
receiveCB ft.ReceiveCallback
@@ -49,6 +51,7 @@ type E2e interface {
newListener receive.Listener) receive.ListenerID
}
+// NewManager generates a new file transfer manager using E2E.
func NewManager(receiveCB ft.ReceiveCallback, params ft.Params, myID *id.ID,
e2e E2e, cmix ft.Cmix, kv *versioned.KV, rng *fastRNG.StreamGenerator) (
ft.FileTransfer, error) {
--
GitLab