rateconn is a Golang library providing rate limited network connections.
It wraps net.Conn and applies rate limiting using golang.org/x/time/rate.
// Create a clamp with overall limit of 1MB/s and per connection limit of 50KB/s
clamp := rateconn.Clamp(rateconn.MBps, rateconn.KBps*50)
listener, _ := clamp.Listen("tcp", "localhost:0")
defer listener.Close()
go func() {
conn, _ := listener.Accept
_, _ = io.ReadAll(conn) // Read at max 50KB/ps
}()
// Dial a rate limited connection
conn, _ := clamp.Dial("tcp", listener.Addr().String())
defer conn.Close()
for {
rconn.Write(make([]byte, 1024)) // Write 0's at 50KB/s
}Connis a rate limited network connection and is the basic building block of this package.Connwraps anet.Connand applies rx and tx rate limits.Wrapcreates a newConnconfigured via functional options.- Options include multiple
TXLimits andRXLimits. - Convenience functions for defining limits:
Bps,KBps,MBps - Convenience functions
ListenandDialcall the equivalentnetpackage functions and return a wrappedConn. Clampgroups multiple rate limited connections, an applies an additional overall clamp limit.Clamponly supports symmetrical rx and tx limits.- Connections can be added to a
ClampviaWrap,Dial,Listenmethods. - Modifying existing limits is supported via
SetClampLimitandSetConnLimit.
- Figure out a nice API for defining different
Clamprx and tx limits. - Align single connection configuration and clamp configuration.
- Use a fake clock for deterministic and more performant testing.