ratelim

Documentation

Index

• type RateLim
  • func New(limit int) (*RateLim, error)
  • func (rl *RateLim) Exec(f func() error)
  • func (rl *RateLim) Wait() []string

Types

type RateLim

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

RateLim allows to logically cap the maximum number of functions. It returns a slice of error strings that happened during execution.

func New

func New(limit int) (*RateLim, error)

New returns a new RateLim.

func (*RateLim) Exec

func (rl *RateLim) Exec(f func() error)

Exec executes f when a slot is available within the defined maximum limit.

func (*RateLim) Wait

func (rl *RateLim) Wait() []string

Wait will block until all executing functions finish, and return all error strings that happened during executions. RateLim can't be reused after this call.