ratelimit

Documentation

Index

• func Clear(ctx context.Context, remoteClient *remotecache.Client, endpoint string) error
• func Endpoint(ctx context.Context, endpoint string, rateLimit int, anonymousOnly bool) error
• func Middleware() gin.HandlerFunc
• func Remote(ctx context.Context, remoteClient *remotecache.Client, endpoint string, ...) error
• type RateLimit

Functions

func Clear

func Clear(ctx context.Context, remoteClient *remotecache.Client, endpoint string) error

Clear the specified remote entry

func Endpoint

func Endpoint(ctx context.Context, endpoint string, rateLimit int, anonymousOnly bool) error

Endpoint protects a specific endpoint from public clients

func Middleware

func Middleware() gin.HandlerFunc

Middleware protects the API globally from anonymous requests

func Remote

func Remote(ctx context.Context, remoteClient *remotecache.Client, endpoint string, rateLimit int, anonymousOnly bool) error

Remote protects a specific endpoint from public clients, with remote client

Types

type RateLimit

type RateLimit struct {
	Increment int
}

RateLimit contains basic data for limit options