ratelimit

Documentation

Overview

Package ratelimit is used to rate-limit requests.

Index

• func Attempt(ctx context.Context, user string, now time.Time, max int, ...) error
• func Clear(ctx context.Context) error

Functions

func Attempt

func Attempt(ctx context.Context, user string, now time.Time, max int, interval time.Duration) error

Attempt determines if a new request by the client identified by user is allowed. An error is returned if max or more successful attempts were already made in interval. Errors can also be returned for datastore failures.

func Clear

func Clear(ctx context.Context) error

Clear deletes all rate-limiting information from datastore for testing.