sideband

type Channel ¶

type Channel byte

Channel sideband channel

const (
	// PackData packfile content
	PackData Channel = 1
	// ProgressMessage progress messages
	ProgressMessage Channel = 2
	// ErrorMessage fatal error message just before stream aborts
	ErrorMessage Channel = 3
)

func (ch Channel) WithPayload(payload []byte) []byte

type Demuxer ¶

type Demuxer struct {

	// Progress is where the progress messages are stored
	Progress Progress
	// contains filtered or unexported fields
}

Demuxer demultiplexes the progress reports and error info interleaved with the packfile itself.

A sideband has three different channels the main one, called PackData, contains the packfile data; the ErrorMessage channel, that contains server errors; and the last one, ProgressMessage channel, containing information about the ongoing task happening in the server (optional, can be suppressed sending NoProgress or Quiet capabilities to the server)

In order to demultiplex the data stream, method `Read` should be called to retrieve the PackData channel, the incoming data from the ProgressMessage is written at `Progress` (if any), if any message is retrieved from the ErrorMessage channel an error is returned and we can assume that the connection has been closed.

func NewDemuxer(t Type, r io.Reader) *Demuxer

func (d *Demuxer) Read(b []byte) (n int, err error)

type Muxer ¶

type Muxer struct {
	// contains filtered or unexported fields
}

Muxer multiplex the packfile along with the progress messages and the error information. The multiplex is perform using pktline format.

func NewMuxer(t Type, w io.Writer) *Muxer

func (m *Muxer) Write(p []byte) (int, error)

func (m *Muxer) WriteChannel(t Channel, p []byte) (int, error)

type Progress ¶

type Progress interface {
	io.Writer
}

Progress where the progress information is stored

type Type ¶

type Type int8

Type sideband type "side-band" or "side-band-64k"