Documentation
¶
Overview ¶
Package rateio provides an io interfaces for rate-limiting.
This can be used to apply rate limiting to any type that implements an io-style interface.
For example, we can use it to restrict the reading rate of a net.Conn:
type limitedConn struct {
net.Conn
io.Reader // Our rate-limited io.Reader for net.Conn
}
func (r *limitedConn) Read(p []byte) (n int, err error) {
return r.Reader.Read(p)
}
// ReadLimitConn returns a net.Conn whose io.Reader interface is rate-limited by limiter.
func ReadLimitConn(conn net.Conn, limiter rateio.Limiter) net.Conn {
return &limitedConn{
Conn: conn,
Reader: rateio.NewReader(conn, limiter),
}
}
Then we can use ReadLimitConn to wrap our existing net.Conn and continue using the wrapped version in its place.
Index ¶
- Variables
- func NewGracefulLimiter(amount int, frequency time.Duration, grace time.Duration) *simpleLimiter
- func NewReader(r io.Reader, limiter Limiter) io.Reader
- func NewSimpleLimiter(amount int, frequency time.Duration) *simpleLimiter
- func NewWriter(w io.Writer, limiter Limiter) io.Writer
- type Limiter
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrRateExceeded = errors.New("Read rate exceeded.")
ErrRateExceeded is the error returned when the read rate exceeds our specification.
Functions ¶
func NewGracefulLimiter ¶
NewGracefulLimiter returns a Limiter that is the same as a SimpleLimiter but adds a grace period at the start of the rate limiting where it allows unlimited bytes to be read during that period.
func NewSimpleLimiter ¶
NewSimpleLimiter creates a Limiter that restricts a given number of bytes per frequency.
Types ¶
Source Files
Click to show internal directories.
Click to hide internal directories.