diff options
| author | Onur Gündüz <ogunduz@gmail.com> | 2026-10-08 02:47:42 +0200 |
|---|---|---|
| committer | Onur Gündüz <ogunduz@gmail.com> | 2026-10-08 02:54:55 +0200 |
| commit | d2ae1381c76f53c14fe4e6e4d9b557887cd93187 (patch) | |
| tree | a4f67413af6bea45a982fba98c5b1826c6fb08e7 /reader.go | |
| parent | 4660317cbba12af5ae1546948785301e7f9108b4 (diff) | |
| download | muxer-d2ae1381c76f53c14fe4e6e4d9b557887cd93187.tar.gz muxer-d2ae1381c76f53c14fe4e6e4d9b557887cd93187.zip | |
Update Go module path and source imports
Diffstat (limited to 'reader.go')
| -rw-r--r-- | reader.go | 22 |
1 files changed, 12 insertions, 10 deletions
@@ -1,12 +1,14 @@ -package binproto +package muxer import ( "errors" "io" ) -// A Reader implements convenience methods for reading requests -// or responses from a binary protocol network connection. +// Reader implements a buffered message reader for the muxer protocol. +// It reads and decodes messages from an underlying io.Reader, handling buffering, +// message framing, and varint-based length encoding. Reader is not safe for +// concurrent use by multiple goroutines. type Reader struct { rd io.Reader r, w int @@ -33,13 +35,14 @@ const ( ) var ( - ErrMessageSizeExceeded = errors.New("binproto: message too big") - ErrMessageMalformed = errors.New("binproto: message malformed") + ErrMessageSizeExceeded = errors.New("muxer: message too big") + ErrMessageMalformed = errors.New("muxer: message malformed") ) // NewReader returns a new Reader reading from r. // // By default, a Reader allocates 4096 bytes for its internal buffer. +// Use NewReaderSize to specify a different buffer size. func NewReader(rd io.Reader) *Reader { return NewReaderSize(rd, defaultBufSize) } @@ -64,13 +67,13 @@ func (b *Reader) fill() { length := len(b.buf) if b.w >= length { - panic("binproto: tried to fill full buffer") + panic("muxer: tried to fill full buffer") } for i := maxConsecutiveEmptyReads; i > 0; i-- { n, err := b.rd.Read(b.buf[b.w:]) if n < 0 { - panic("binproto: reader returned negative count from Read") + panic("muxer: reader returned negative count from Read") } b.w += n if err != nil { @@ -92,7 +95,7 @@ func (b *Reader) fill() { b.err = io.ErrNoProgress } -// ReadMessage reads a single message from r. +// ReadMessage reads a single message from r into the provided Message struct. func (b *Reader) ReadMessage(message *Message) (err error) { for { if b.err != nil { @@ -151,8 +154,7 @@ func (b *Reader) ReadMessage(message *Message) (err error) { return } -// Reset resets this Reader with the new source r, using -// the existing buffer. +// Reset resets this Reader with the new source r, using the existing buffer. func (b *Reader) Reset(r io.Reader) { if b.buf == nil { b.buf = make([]byte, defaultBufSize) |
