network

Documentation

Index

• func NewLimiter(t Tier, burst uint, boost int) *rate.Limiter
• func SetMaxAllowedWaitTime(d time.Duration)
• func WithRetry(ctx context.Context, lim *rate.Limiter, maxAttempts int, fn func() error) error
• type ErrRetryFailed
  • func (e *ErrRetryFailed) Error() string
  • func (e *ErrRetryFailed) Is(target error) bool
  • func (e *ErrRetryFailed) Unwrap() error
• type Tier

Functions

func NewLimiter

func NewLimiter(t Tier, burst uint, boost int) *rate.Limiter

NewLimiter returns throttler with rateLimit requests per minute. optionally caller may specify the boost

func SetMaxAllowedWaitTime

func SetMaxAllowedWaitTime(d time.Duration)

SetMaxAllowedWaitTime sets the maximum time to wait for a transient error.

func WithRetry

func WithRetry(ctx context.Context, lim *rate.Limiter, maxAttempts int, fn func() error) error

WithRetry will run the callback function fn. If the function returns slack.RateLimitedError, it will delay, and then call it again up to maxAttempts times. It will return an error if it runs out of attempts.

Types

type ErrRetryFailed

type ErrRetryFailed struct {
	Err error
}

ErrRetryFailed is returned if number of retry attempts exceeded the retry attempts limit and function wasn't able to complete without errors.

func (*ErrRetryFailed) Error

func (e *ErrRetryFailed) Error() string

func (*ErrRetryFailed) Is

func (e *ErrRetryFailed) Is(target error) bool

func (*ErrRetryFailed) Unwrap

func (e *ErrRetryFailed) Unwrap() error

type Tier

type Tier int

Tier represents rate limit Tier: https://api.slack.com/docs/rate-limits

const (
	// base throttling defined as events per minute
	NoTier Tier = 6000 // no Tier is applied

	// Tier1 Tier = 1
	Tier2 Tier = 20
	Tier3 Tier = 50
	Tier4 Tier = 100
)