# README

Data Flow Rate Control

To download and install this package run:

go get github.com/mxk/go-flowrate/flowrate

The documentation is available at:

New creates a new flow control monitor.

NewReader restricts all Read operations on r to limit bytes per second.

NewWriter restricts all Write operations on w to limit bytes per second.

ErrLimit is returned by the Writer when a non-blocking write is short due to the transfer rate limit.

Monitor monitors and limits the transfer rate of a data stream.

Reader implements io.ReadCloser with a restriction on the rate of data transfer.

Status represents the current Monitor status.

Writer implements io.WriteCloser with a restriction on the rate of data transfer.

Limiter is implemented by the Reader and Writer to provide a consistent interface for monitoring and controlling data transfer.

Percent represents a percentage in increments of 1/1000th of a percent.