ratelimit

README

ratelimit

global ratelimiter for network connections in golang

Documentation

Index

• func NewRLConn(conn net.Conn, rl *RateLimit, cancel <-chan struct{}) net.Conn
• func NewRLReadWriter(rw io.ReadWriter, rl *RateLimit, cancel <-chan struct{}) io.ReadWriter
• func NewRLStream(stream siamux.Stream, rl *RateLimit, cancel <-chan struct{}) siamux.Stream
• type RateLimit
  • func NewRateLimit(readBPS, writeBPS int64, packetSize uint64) *RateLimit
  • func (rl *RateLimit) Limits() (int64, int64, uint64)
  • func (rl *RateLimit) SetLimits(readBPS, writeBPS int64, packetSize uint64)

Functions

func NewRLConn

func NewRLConn(conn net.Conn, rl *RateLimit, cancel <-chan struct{}) net.Conn

NewRLConn wraps a net.Conn into a rlReadWriter.

func NewRLReadWriter

func NewRLReadWriter(rw io.ReadWriter, rl *RateLimit, cancel <-chan struct{}) io.ReadWriter

NewRLReadWriter wraps a io.ReadWriter into a rlReadWriter.

func NewRLStream

func NewRLStream(stream siamux.Stream, rl *RateLimit, cancel <-chan struct{}) siamux.Stream

NewRLStream wraps a net.Conn into a rlReadWriter.

Types

type RateLimit

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

RateLimit declares the global rate limit for read and write operations on a io.ReadWriter. Whenever a caller wants to read or write, they have to wait until readBlock/writeBlock to start the actual read or write operation. Each caller also pushes these timestamps into the future to prevent other callers to read or write prematurely.

func NewRateLimit

func NewRateLimit(readBPS, writeBPS int64, packetSize uint64) *RateLimit

NewRateLimit creates a new rateLimit object that can be used to initialize rate-limited readers and writers.

func (*RateLimit) Limits

func (rl *RateLimit) Limits() (int64, int64, uint64)

Limits gets the current limits for the global rate limiter.

func (*RateLimit) SetLimits

func (rl *RateLimit) SetLimits(readBPS, writeBPS int64, packetSize uint64)

SetLimits sets new limits for the global rate limiter.