shithub: furgit

ref: df1f2fb3daa1acd25c88510f259d5535fb482126
dir: /network/protocol/sideband64k/encoder.go/

package sideband64k

import (
	"fmt"

	"codeberg.org/lindenii/furgit/common/iowrap"
	"codeberg.org/lindenii/furgit/network/protocol/pktline"
)

// Encoder writes side-band-64k frames to a flush-capable output transport.
//
// It writes exactly one frame per method call and does not auto-chunk data.
//
// Labels: MT-Unsafe.
type Encoder struct {
	enc     *pktline.Encoder
	maxData int
}

// NewEncoder creates an encoder over w.
//
// Labels: Deps-Borrowed, Life-Parent.
func NewEncoder(w iowrap.WriteFlusher) *Encoder {
	return &Encoder{
		enc:     pktline.NewEncoder(w),
		maxData: DataMax,
	}
}

// SetMaxData sets the maximum payload size accepted by WriteBand.
//
// Non-positive n resets to DataMax.
func (e *Encoder) SetMaxData(n int) {
	if n <= 0 {
		e.maxData = DataMax

		return
	}

	e.maxData = n
}

// WriteBand writes one side-band-64k data frame for the given band.
func (e *Encoder) WriteBand(band Band, p []byte) error {
	if !validBand(band) {
		return fmt.Errorf("%w: %d", ErrInvalidBand, band)
	}

	maxData := e.effectiveMaxData()
	if len(p) > maxData {
		return fmt.Errorf("%w: %d > %d", ErrTooLarge, len(p), maxData)
	}

	framed := make([]byte, len(p)+1)
	framed[0] = byte(band)
	copy(framed[1:], p)

	return e.enc.WriteData(framed)
}

// WriteData writes one band-1 data frame.
func (e *Encoder) WriteData(p []byte) error {
	return e.WriteBand(BandData, p)
}

// WriteProgress writes one band-2 progress frame.
func (e *Encoder) WriteProgress(p []byte) error {
	return e.WriteBand(BandProgress, p)
}

// WriteError writes one band-3 error frame.
func (e *Encoder) WriteError(p []byte) error {
	return e.WriteBand(BandError, p)
}

// WriteFlushPacket writes control frame 0000 (flush-pkt).
func (e *Encoder) WriteFlushPacket() error {
	return e.enc.WriteFlushPacket()
}

// WriteDelimPacket writes control frame 0001 (delim-pkt).
func (e *Encoder) WriteDelimPacket() error {
	return e.enc.WriteDelimPacket()
}

// WriteResponseEndPacket writes control frame 0002 (response-end-pkt).
func (e *Encoder) WriteResponseEndPacket() error {
	return e.enc.WriteResponseEndPacket()
}

// Flush flushes buffered output in the underlying transport.
func (e *Encoder) Flush() error {
	return e.enc.Flush()
}

// WriteFlushPacketAndFlush writes a flush-pkt (0000) then flushes transport I/O.
func (e *Encoder) WriteFlushPacketAndFlush() error {
	return e.enc.WriteFlushPacketAndFlush()
}

func (e *Encoder) effectiveMaxData() int {
	return effectiveMaxData(e.maxData)
}