From cebc15d6e11e35ef3eeee55b5444f5bbcc411931 Mon Sep 17 00:00:00 2001 From: onur1 Date: Sun, 1 Jan 2023 18:55:26 +0100 Subject: Update README --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca301ad..0e73a05 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ # binproto -generic support for binary-based request response protocols. +binproto implements generic support for binary-based request response protocols. ## Message format -binproto header is a varint encoded unsigned 64-bit integer which consist of an ID (first 60-bits) and a Channel number (last 4-bits). The rest of the message is data. +Over the wire messages are length-prefixed and packed in the following format: + +``` + + + +``` + +Each message starts with an header which is a varint encoded unsigned 64-bit integer which consists of an ID (first 60-bits) and a Channel number (last 4-bits), the rest of the message is payload. + ## Buffered -- cgit v1.3.1