middleware

Documentation

Index

• func KeyAuthFunc(authenticator preshared.KeyAuthenticator) grpcAuth.AuthFunc
• type RateLimiter
  • func NewRateLimiter(reqPerSec int64) *RateLimiter
  • func (l *RateLimiter) Limit(_ context.Context) error

Functions

func KeyAuthFunc

func KeyAuthFunc(authenticator preshared.KeyAuthenticator) grpcAuth.AuthFunc

KeyAuthFunc - Middleware that responsible for key authentication

Types

type RateLimiter

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

RateLimiter struct is a wrapper around the juju Bucket struct

func NewRateLimiter

func NewRateLimiter(reqPerSec int64) *RateLimiter

NewRateLimiter is a constructor function for RateLimiter. It creates a new RateLimiter that allows reqPerSec requests per second.

func (*RateLimiter) Limit

func (l *RateLimiter) Limit(_ context.Context) error

Limit checks if a request should be allowed based on the current state of the bucket. If no tokens are available (i.e., if TakeAvailable(1) returns 0), it means the rate limit has been hit, so it returns true. If a token is available, it returns false, meaning the request can proceed.