request

package

v0.0.3 Latest Latest Go to latest Published: Sep 1, 2023 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dkotik/oakratelimiter

Links

Open Source Insights

Documentation ¶

Overview ¶

Package request defines and implements Limiter and Tagger for throttling [http.Request]s.

Index ¶

type ContextTagger
type Limiter
- func NewLimiter(t Tagger, l rate.Limiter) (Limiter, error)
- func NewStaticLimiter(tag string, l rate.Limiter) (Limiter, error)
type Tagger
- func NewRequestTaggerFromContextTagger(t ContextTagger) Tagger

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ContextTagger ¶

type ContextTagger func(context.Context) (string, error)

ContextTagger is used together with NewRequestTaggerFromContextTagger to tag requests based on context values. This can help with rate-limiting requests by a role.

type Limiter ¶

type Limiter interface {
	Rate() *rate.Rate
	Take(
		*http.Request,
	) (
		remaining float64,
		ok bool,
		err error,
	)
}

func NewLimiter ¶

func NewLimiter(t Tagger, l rate.Limiter) (Limiter, error)

func NewStaticLimiter ¶

func NewStaticLimiter(tag string, l rate.Limiter) (Limiter, error)

type Tagger ¶

type Tagger func(*http.Request) (string, error)

Tagger associates tags to [http.Request]s in order to group related requests for a discriminating rate limiter. Requests with the same association tag will be tracked together by the Limiter.

func NewRequestTaggerFromContextTagger ¶

func NewRequestTaggerFromContextTagger(t ContextTagger) Tagger

NewRequestTaggerFromContextTagger adapts a ContextTagger to a Tagger.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
tagbycontext Package tagbycontext implements [request.Limiter] by extracting values from request context.Context.	Package tagbycontext implements [request.Limiter] by extracting values from request context.Context.
tagbycookie Package tagbycookie implements [request.Limiter] by extracting an HTTP cookie from [http.Request]s.	Package tagbycookie implements [request.Limiter] by extracting an HTTP cookie from [http.Request]s.
tagbyheader Package tagbyheader implements [request.Limiter] by extracting an HTTP header value from [http.Request]s.	Package tagbyheader implements [request.Limiter] by extracting an HTTP header value from [http.Request]s.
tagbyip Package tagbyip implements [request.Limiter] by extracting Internet Protocol addresses from [http.Request]s.	Package tagbyip implements [request.Limiter] by extracting Internet Protocol addresses from [http.Request]s.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL