Files
zosbuilder/docs/packet.md
Jan De Landtsheer 10025f9fa5 Squashed 'components/mycelium/' content from commit afb32e0
git-subtree-dir: components/mycelium
git-subtree-split: afb32e0cdb2d4cdd17f22a5693278068d061f08c
2025-08-16 21:12:34 +02:00

1003 B

Packet

A Packet is the largest communication object between established peers. All communication is done via these packets. The packet itself consists of a fixed size header, and a variable size body. The body contains a more specific type of data.

Packet header

The packet header has a fixed size of 4 bytes, with the following layout:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|    Version    |      Type     |            Reserved           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

The first byte is used to indicate the version of the protocol. Currently, only version 1 is supported (0x01). The next byte is used to indicate the type of the body. 0x00 indicates a data packet, while 0x01 indicates a control packet. The remaining 16 bits are currently reserved, and should be set to all 0.