aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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.