limiter

Documentation

Index

• type Run
  • func New(maxRequests, rps int, maxDuration time.Duration) *Run
  • func (r *Run) More() bool
  • func (r *Run) Stop()

Types

type Run

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

Run represents a single run that is limited by either a number of requests, or can be stopped halfway.

func New

func New(maxRequests, rps int, maxDuration time.Duration) *Run

New returns

func (*Run) More

func (r *Run) More() bool

More returns whether more requests can be started or whether we have reached some limit. If more requests can be made, it blocks until the rate limiter allows another request.

func (*Run) Stop

func (r *Run) Stop()

Stop will ensure that all future calls to More return false.