aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoronur1 <onur1@onurgunduz.com>2022-01-10 07:38:40 +0100
committeronur1 <onur1@onurgunduz.com>2022-01-10 07:38:40 +0100
commit02387a1dc1ec156e0613920645cf47a51a04a930 (patch)
treedfea280e7791fc09128f31354cc632cc33ea43e7
parentef3da1cf5a59d89136730eb591bca3a0fbd070d2 (diff)
downloadmuxer-02387a1dc1ec156e0613920645cf47a51a04a930.tar.gz
muxer-02387a1dc1ec156e0613920645cf47a51a04a930.zip
Update README
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index d8a32bb..ca301ad 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
# binproto
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.
+
+## Buffered
+
+binproto uses an internal buffer which allocates 4096 bytes by default. You can adjust this value if your protocol requires larger (or smaller) chunks.