tollbooth_fasthttp

README

tollbooth_fasthttp

Fasthttp middleware for rate limiting HTTP requests.

Five Minutes Tutorial

package main

import (
	"time"

	"github.com/syreclabs/tollbooth"
	"github.com/magicwrighter/tollbooth/thirdparty/tollbooth_fasthttp"
	"github.com/valyala/fasthttp"
)

func main() {
	requestHandler := func(ctx *fasthttp.RequestCtx) {
		switch string(ctx.Path()) {
		case "/hello":
			helloHandler(ctx)
		default:
			ctx.Error("Unsupporterd path", fasthttp.StatusNotFound)
		}
	}

	// Create a limiter struct.
	limiter := tollbooth.NewLimiter(1, time.Second)

	fasthttp.ListenAndServe(":4444", tollbooth_fasthttp.LimitHandler(requestHandler, limiter))
}

func helloHandler(ctx *fasthttp.RequestCtx) {
	ctx.SetStatusCode(fasthttp.StatusOK)
	ctx.SetBody([]byte("Hello, World!"))
}

Documentation

Index

• func BuildKeys(limiter *config.Limiter, ctx *fasthttp.RequestCtx) [][]string
• func LimitByRequest(limiter *config.Limiter, ctx *fasthttp.RequestCtx) *errors.HTTPError
• func LimitHandler(handler fasthttp.RequestHandler, limiter *config.Limiter) fasthttp.RequestHandler
• func RemoteIP(ipLookups []string, ctx *fasthttp.RequestCtx) string
• func StringInSlice(sliceString []string, needle string) bool

Functions

func BuildKeys

func BuildKeys(limiter *config.Limiter, ctx *fasthttp.RequestCtx) [][]string

BuildKeys generates a slice of keys to rate-limit by given config and request structs.

func LimitByRequest

func LimitByRequest(limiter *config.Limiter, ctx *fasthttp.RequestCtx) *errors.HTTPError

func LimitHandler

func LimitHandler(handler fasthttp.RequestHandler, limiter *config.Limiter) fasthttp.RequestHandler

func RemoteIP

func RemoteIP(ipLookups []string, ctx *fasthttp.RequestCtx) string

RemoteIP finds IP Address given http.Request struct.

func StringInSlice

func StringInSlice(sliceString []string, needle string) bool

StringInSlice finds needle in a slice of strings.