diff options
| author | Onur Gündüz <ogunduz@gmail.com> | 2026-02-10 15:03:55 +0100 |
|---|---|---|
| committer | Onur Gündüz <ogunduz@gmail.com> | 2026-02-10 15:03:55 +0100 |
| commit | 4660317cbba12af5ae1546948785301e7f9108b4 (patch) | |
| tree | 369de1c56b0dc774e2b6d9b29739601304688231 | |
| parent | 3650f193abcee4dbc71922c6ecf59fcbcea3637b (diff) | |
| download | muxer-4660317cbba12af5ae1546948785301e7f9108b4.tar.gz muxer-4660317cbba12af5ae1546948785301e7f9108b4.zip | |
Naming
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | example_test.go | 4 | ||||
| -rw-r--r-- | message.go | 18 | ||||
| -rw-r--r-- | reader.go | 2 | ||||
| -rw-r--r-- | reader_test.go | 8 | ||||
| -rw-r--r-- | writer.go | 2 | ||||
| -rw-r--r-- | writer_test.go | 2 |
7 files changed, 19 insertions, 19 deletions
@@ -8,7 +8,7 @@ Simple binary messaging protocol with multiplexing support. ``` ┌──────────────────────────────────────────────┐ -│ length | channel ID × channel type │ payload │ +│ length | channel ID × message type │ payload │ └──────────────────────────────────────────────┘ └─ 60-bits └─ 4-bits ``` diff --git a/example_test.go b/example_test.go index 5b31475..0547111 100644 --- a/example_test.go +++ b/example_test.go @@ -27,7 +27,7 @@ func ExampleDial() { return } - fmt.Printf("%d %d %s\n", msg.ID, msg.Channel, msg.Data) + fmt.Printf("%d %d %s\n", msg.ID, msg.Type, msg.Data) s.close() } @@ -65,7 +65,7 @@ func (s *server) handle(conn net.Conn) { return } - fmt.Printf("%d %d %s\n", msg.ID, msg.Channel, msg.Data) + fmt.Printf("%d %d %s\n", msg.ID, msg.Type, msg.Data) _, err = c.Send(binproto.NewMessage(112, 5, []byte("hey"))) if err != nil { @@ -3,19 +3,19 @@ package binproto // A Message represents a single binproto message. // // 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. +// unsigned 64-bit integer which consists of a channel ID (first 60-bits) and +// a message type (last 4-bits), the rest of the message is payload. type Message struct { - ID uint64 - Channel uint8 - Data []byte + ID uint64 + Type uint8 + Data []byte } // NewMessage returns a new Message. -func NewMessage(id uint64, ch uint8, data []byte) *Message { +func NewMessage(id uint64, messageType uint8, data []byte) *Message { return &Message{ - ID: id, - Channel: ch, - Data: data, + ID: id, + Type: messageType, + Data: data, } } @@ -105,7 +105,7 @@ func (b *Reader) ReadMessage(message *Message) (err error) { // Found message? if b.state == 0 && b.ready { message.ID = b.header >> 4 - message.Channel = uint8(b.header & 0b1111) + message.Type = uint8(b.header & 0b1111) message.Data = b.latest[:b.latestN] b.ready = false b.latestN = 0 diff --git a/reader_test.go b/reader_test.go index e1404da..31825a6 100644 --- a/reader_test.go +++ b/reader_test.go @@ -430,9 +430,9 @@ func reader(q [][]byte, size int) *binproto.Reader { func newMessage(id uint64, ch uint8, l int) *binproto.Message { return &binproto.Message{ - ID: id, - Channel: ch, - Data: []byte(fill(l)), + ID: id, + Type: ch, + Data: []byte(fill(l)), } } @@ -643,7 +643,7 @@ func TestReaderReset(t *testing.T) { err = r.ReadMessage(m) assert.NoError(t, err) assert.Equal(t, uint64(99), m.ID) - assert.Equal(t, uint8(7), m.Channel) + assert.Equal(t, uint8(7), m.Type) assert.Equal(t, 10, len(m.Data)) } @@ -20,7 +20,7 @@ func NewWriter(wd *bufio.Writer) *Writer { // WriteMessage writes a variable number of messages to w. func (w *Writer) WriteMessage(messages ...*Message) error { for _, m := range messages { - header := m.ID<<4 | uint64(m.Channel) + header := m.ID<<4 | uint64(m.Type) headerLen := binary.PutUvarint(w.scratch[10:], header) bodyLen := uint64(headerLen + len(m.Data)) lengthSize := binary.PutUvarint(w.scratch[:10], bodyLen) diff --git a/writer_test.go b/writer_test.go index 90392d1..555743d 100644 --- a/writer_test.go +++ b/writer_test.go @@ -44,7 +44,7 @@ func TestWriteMessageNilData(t *testing.T) { err = r.ReadMessage(m) assert.NoError(t, err) assert.Equal(t, uint64(100), m.ID) - assert.Equal(t, uint8(5), m.Channel) + assert.Equal(t, uint8(5), m.Type) assert.Equal(t, 0, len(m.Data)) } |
