Skip to content

aybabtme/iocontrol

Repository files navigation

iocontrol

-- import "github.com/aybabtme/iocontrol"

Package iocontrol offers io.Writer, io.Reader, io.WriterAt, and io.ReaderAt implementations that allow one to measure and throttle the rate at which data is transferred.

Usage

const (
	KiB = 1 << 10
	MiB = 1 << 20
	GiB = 1 << 30
)

Orders of magnitude of data, in kibibyte (powers of 2, or multiples of 1024). See https://en.wikipedia.org/wiki/Kibibyte.

Exposed Methods and Types

For all of the exposed functionality, there are versions for all of io.{Reader,Writer}At with intuitive naming conventions.

The io.{Reader,Writer} implementations are documented below.

func ThrottledReader

func ThrottledReader(r io.Reader, bytesPerSec int, maxBurst time.Duration) io.Reader

ThrottledReader ensures that reads to r never exceeds a specified rate of bytes per second. The maxBurst duration changes how often the verification is done. The smaller the value, the less bursty, but also the more overhead there is to the throttling.

func ThrottledWriter

func ThrottledWriter(w io.Writer, bytesPerSec int, maxBurst time.Duration) io.Writer

ThrottledWriter ensures that writes to w never exceeds a specified rate of bytes per second. The maxBurst duration changes how often the verification is done. The smaller the value, the less bursty, but also the more overhead there is to the throttling.

type MeasuredReader

type MeasuredReader struct {
}

MeasuredReader wraps a reader and tracks how many bytes are read to it.

func NewMeasuredReader

func NewMeasuredReader(r io.Reader) *MeasuredReader

NewMeasuredReader wraps a reader.

func (*MeasuredReader) BytesPer

func (m *MeasuredReader) BytesPer(perPeriod time.Duration) uint64

BytesPer tells the rate per period at which bytes were read since last measurement.

func (*MeasuredReader) BytesPerSec

func (m *MeasuredReader) BytesPerSec() uint64

BytesPerSec tells the rate per second at which bytes were read since last measurement.

func (*MeasuredReader) Read

func (m *MeasuredReader) Read(b []byte) (n int, err error)

func (*MeasuredReader) Total

func (m *MeasuredReader) Total() int

Total number of bytes that have been read.

type MeasuredWriter

type MeasuredWriter struct {
}

MeasuredWriter wraps a writer and tracks how many bytes are written to it.

func NewMeasuredWriter

func NewMeasuredWriter(w io.Writer) *MeasuredWriter

NewMeasuredWriter wraps a writer.

func (*MeasuredWriter) BytesPer

func (m *MeasuredWriter) BytesPer(perPeriod time.Duration) uint64

BytesPer tells the rate per period at which bytes were written since last measurement.

func (*MeasuredWriter) BytesPerSec

func (m *MeasuredWriter) BytesPerSec() uint64

BytesPerSec tells the rate per second at which bytes were written since last measurement.

func (*MeasuredWriter) Total

func (m *MeasuredWriter) Total() int

Total number of bytes that have been written.

func (*MeasuredWriter) Write

func (m *MeasuredWriter) Write(b []byte) (n int, err error)

About

Measure and throttle the rate at which data is transferred.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages