diff options
| author | onur1 <onur1@onurgunduz.com> | 2023-01-04 22:23:00 +0100 |
|---|---|---|
| committer | onur1 <onur1@onurgunduz.com> | 2023-01-04 22:23:00 +0100 |
| commit | 21242fdf05974d4dfeee32595d43f5bc44116387 (patch) | |
| tree | b4f36cfa7e5927d51b8261952f86beacf9cb17c0 | |
| parent | cebc15d6e11e35ef3eeee55b5444f5bbcc411931 (diff) | |
| download | muxer-21242fdf05974d4dfeee32595d43f5bc44116387.tar.gz muxer-21242fdf05974d4dfeee32595d43f5bc44116387.zip | |
Update README
| -rw-r--r-- | README.md | 19 |
1 files changed, 5 insertions, 14 deletions
@@ -1,20 +1,11 @@ # binproto -binproto implements generic support for binary-based request response protocols. +binproto implements generic support for binary-based request response protocols. You can use it to create your own binary network protocols for things like RPC or file transfer. -## Message format + -Over the wire messages are length-prefixed and packed in the following format: +[**Getting started with binproto**](https://onurgunduz.com/binproto) -``` -<varint - length of rest of message> - <varint - header> - <payload> -``` +[**See the full API documentation at pkg.go.dev**](https://pkg.go.dev/github.com/onur1/binproto) -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 - -binproto uses an internal buffer which allocates 4096 bytes by default. You can adjust this value if your protocol requires larger (or smaller) chunks. +[Report a bug or suggest a feature](https://github.com/onur1/binproto/issues) |
