middleware

Documentation

Index

• Variables
• func CreateEndpointThrottler(throttlerName string) gin.HandlerFunc
• func NewGlobalThrottler(maxConnections uint32) (*globalThrottler, error)
• func NewSourceThrottler(maxNumRequests uint32) (*sourceThrottler, error)
• func WithFacade(facade Handler) gin.HandlerFunc
• type Handler

Variables

var ErrInvalidMaxNumRequests = errors.New("max number of requests value is invalid")

ErrInvalidMaxNumRequests signals that a provided number of requests is invalid

var ErrTooManyRequests = errors.New("too many requests")

ErrTooManyRequests signals that too many requests were simultaneously received

Functions

func CreateEndpointThrottler

func CreateEndpointThrottler(throttlerName string) gin.HandlerFunc

CreateEndpointThrottler will create a middleware-type of handler to be used in conjunction with special REST API end points that need to be better protected

func NewGlobalThrottler

func NewGlobalThrottler(maxConnections uint32) (*globalThrottler, error)

NewGlobalThrottler creates a new instance of a globalThrottler

func NewSourceThrottler

func NewSourceThrottler(maxNumRequests uint32) (*sourceThrottler, error)

NewSourceThrottler creates a new instance of a sourceThrottler

func WithFacade

func WithFacade(facade Handler) gin.HandlerFunc

WithFacade middleware will set up a facade object in the gin context

Types

type Handler

type Handler interface {
}

Handler interface defines methods that can be used from `facade` context variable