limit

Documentation

Index

• Variables
• func NonBlockingRequest(u string, perMinute int) bool
• func Request(u string, perMinute int)
• type RateLimiter
  • func (s *RateLimiter) NonBlockingRequest(u string, perMinute int) bool
  • func (s *RateLimiter) Request(u string, perMinute int)

Variables

var DefaultLimiter = &RateLimiter{
	Map:   make(map[string]chan struct{}),
	Mutex: &sync.RWMutex{},
}

DefaultLimiter is the RateLimiter used by the package-level Request and NonBlockingRequest.

Functions

func NonBlockingRequest

func NonBlockingRequest(u string, perMinute int) bool

NonBlockingRequest is a NonBlockingRequest with DefaultLimiter.

func Request

func Request(u string, perMinute int)

Request is a Request with DefaultLimiter.

Types

type RateLimiter

type RateLimiter struct {
	Map   map[string]chan struct{}
	Mutex *sync.RWMutex
}

RateLimiter is a simple rate limiter.

func (*RateLimiter) NonBlockingRequest

func (s *RateLimiter) NonBlockingRequest(u string, perMinute int) bool

NonBlockingRequest checks if it can do a request. If it can't, it returns false, else it returns true if the request succeded.

func (*RateLimiter) Request

func (s *RateLimiter) Request(u string, perMinute int)

Request is a simple request. Blocks until it can make the request.