From b4eed82e5d6156c3dbbf1ee6a98b825a5834f343 Mon Sep 17 00:00:00 2001 From: SG Date: Wed, 24 May 2023 13:49:46 +0200 Subject: [PATCH] Initial documentation for Transmat --- transphase/docs/Message.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 transphase/docs/Message.md diff --git a/transphase/docs/Message.md b/transphase/docs/Message.md new file mode 100644 index 0000000..ca095c1 --- /dev/null +++ b/transphase/docs/Message.md @@ -0,0 +1,17 @@ +# Transmat message format +## ver. 0.1 + +### Message +* msgtype (announce, data, confirmation) +* per_group_id +* role (send, receive) +* payload (encrypted payload containing file chunks and service metadata) +* *TODO - Add protocol version number* + +### Payload +* filename (current filename without path) +* chunk_size (size of each chunk) +* chunk_id (number of current chunk) +* numbr of chunks (total number of chunks in file) +* chunk (current data) +* *TODO - Add a hash of the chunk data to use in confirmation messages* \ No newline at end of file