Initial documentation for Transmat
This commit is contained in:
17
transphase/docs/Message.md
Normal file
17
transphase/docs/Message.md
Normal file
@@ -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*
|
||||||
Reference in New Issue
Block a user