limiter

Documentation

Overview

Package limiter provides a simple limiter middleware.

Index

• type Limiter
  • func New(key func(*ws.Context) interface{}) *Limiter
  • func (a *Limiter) Check(ctx *ws.Context) error
  • func (a *Limiter) Rate(d time.Duration, c int) *Limiter
  • func (a *Limiter) Size(n int64) *Limiter

Types

type Limiter

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

Limiter represents a limiter middleware.

func New

func New(key func(*ws.Context) interface{}) *Limiter

New creates a new limiter middleware.

func (*Limiter) Check

func (a *Limiter) Check(ctx *ws.Context) error

Check checks the limiter.

func (*Limiter) Rate

func (a *Limiter) Rate(d time.Duration, c int) *Limiter

Rate limits the request rate.

func (*Limiter) Size

func (a *Limiter) Size(n int64) *Limiter

Size limits the request body size.