middleware

Documentation

Index

• Variables
• func Register(name string, factory Factory)
• type Factory
• type Middleware
  • func Chain(m ...Middleware) Middleware
  • func Create(c *configv1.Middleware) (Middleware, func(), error)
• type Registry
  • func NewRegistry() Registry
• type RoundTripperFunc
  • func (f RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)

Variables

var EmptyCleanup = func() {}

var EmptyMiddleware = func(tripper http.RoundTripper) http.RoundTripper { return tripper }

var ErrNotFound = errors.New("Middleware has not been registered")

ErrNotFound is middleware not found.

Functions

func Register

func Register(name string, factory Factory)

Register registers one middleware.

Types

type Factory

type Factory func(*configv1.Middleware) (middleware Middleware, cleanup func(), err error)

Factory is a middleware factory.

type Middleware

type Middleware func(http.RoundTripper) http.RoundTripper

Middleware is handler middleware.

func Chain

func Chain(m ...Middleware) Middleware

Chain returns a Middleware that specifies the chained handler for endpoint.

func Create

func Create(c *configv1.Middleware) (Middleware, func(), error)

Create instantiates a middleware based on `cfg`.

type Registry

type Registry interface {
	Register(name string, factory Factory)
	Create(c *configv1.Middleware) (Middleware, func(), error)
}

func NewRegistry

func NewRegistry() Registry

NewRegistry returns a new middleware registry.

type RoundTripperFunc

type RoundTripperFunc func(*http.Request) (*http.Response, error)

RoundTripperFunc is an adapter to allow the use of ordinary functions as HTTP RoundTripper.

func (RoundTripperFunc) RoundTrip

func (f RoundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip calls f(w, r).