limiter

Documentation

Index

• type Limiter
  • func NewLimiter(perSecondLimit int64) *Limiter
  • func (l *Limiter) Register(dataLen int)
• type WriteLimiter
  • func NewWriteLimiter(w io.Writer, limiter *Limiter) *WriteLimiter
  • func (wl *WriteLimiter) Close() error
  • func (wl *WriteLimiter) Write(p []byte) (n int, err error)

Types

type Limiter

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

Limiter controls the amount of budget that can be spent according to configured perSecondLimit

func NewLimiter

func NewLimiter(perSecondLimit int64) *Limiter

NewLimiter creates a Limiter object for the given perSecondLimit

func (*Limiter) Register

func (l *Limiter) Register(dataLen int)

Register blocks for amount of time needed to process the given dataLen according to the configured perSecondLimit.

type WriteLimiter

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

WriteLimiter limits the amount of bytes written per second via Write() method. Must be created via NewWriteLimiter.

func NewWriteLimiter

func NewWriteLimiter(w io.Writer, limiter *Limiter) *WriteLimiter

NewWriteLimiter creates a new WriteLimiter object for the give writer and Limiter.

func (*WriteLimiter) Close

func (wl *WriteLimiter) Close() error

Close implements io.Closer also calls Close for wrapped io.WriteCloser

func (*WriteLimiter) Write

func (wl *WriteLimiter) Write(p []byte) (n int, err error)

Write implements io.Writer