aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fe559758fc8fda5c32b3d7154e76c1400a2d1ee4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# binproto

Simple binary messaging protocol with multiplexing support.

[![Go Reference](https://pkg.go.dev/badge/github.com/tetsuo/binproto.svg)](https://pkg.go.dev/github.com/tetsuo/binproto)

## Message structure

```
┌──────────────────────────────────────────────┐
│ length | channel ID × channel type │ payload │
└──────────────────────────────────────────────┘
           └─ 60-bits   └─ 4-bits
```

## Benchmarks

```
goos: darwin
goarch: arm64
pkg: github.com/tetsuo/binproto
cpu: Apple M4 Pro
BenchmarkWriter_64B-12          100000000               12.15 ns/op     5266.44 MB/s           0 B/op          0 allocs/op
BenchmarkWriter_4KB-12          14390127                81.01 ns/op     50564.20 MB/s          0 B/op          0 allocs/op
BenchmarkWriter_1MB-12             75183             15905 ns/op        65925.85 MB/s         14 B/op          0 allocs/op
BenchmarkReader_64B-12          70587026                16.55 ns/op     3868.22 MB/s           0 B/op          0 allocs/op
BenchmarkReader_4KB-12          15426055                78.05 ns/op     52477.75 MB/s          0 B/op          0 allocs/op
BenchmarkReader_1MB-12             38109             31472 ns/op        33317.35 MB/s         27 B/op          0 allocs/op
```