handlers

Documentation

Index

• Variables
• func MakeDelete(sr consul.ServiceResolver, client nomad.Job, logger hclog.Logger, ...) http.HandlerFunc
• func MakeDeploy(client nomad.Job, providerConfig types.ProviderConfig, logger hclog.Logger, ...) http.HandlerFunc
• func MakeExtractFunctionMiddleWare(getVars func(*http.Request) map[string]string, next http.HandlerFunc) http.HandlerFunc
• func MakeHealthHandler() http.HandlerFunc
• func MakeInfo(logger hclog.Logger, stats metrics.StatsD, version string) http.HandlerFunc
• func MakeProxy(config ProxyConfig) http.HandlerFunc
• func MakeReader(client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc
• func MakeReplicationReader(client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc
• func MakeReplicationWriter(client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc
• type HTTPProxyClient
  • func MakeProxyClient(timeout time.Duration, l hclog.Logger) *HTTPProxyClient
  • func (pc *HTTPProxyClient) CallAndReturnResponse(address string, body []byte, headers http.Header) ([]byte, http.Header, error)
  • func (pc *HTTPProxyClient) GetFunctionName(r *http.Request) string
• type MockProxyClient
  • func (mp *MockProxyClient) CallAndReturnResponse(address string, body []byte, h http.Header) ([]byte, http.Header, error)
  • func (mp *MockProxyClient) GetFunctionName(r *http.Request) string
• type Proxy
  • func (p *Proxy) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type ProxyClient
• type ProxyConfig

Variables

var FunctionNameCTXKey = struct{}{}

FunctionNameCTXKey is a context key which points to the location of the function name set bu the ExtractFunction middleware

Functions

func MakeDelete

func MakeDelete(sr consul.ServiceResolver, client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc

MakeDelete creates a handler for deploying functions

func MakeDeploy

func MakeDeploy(client nomad.Job, providerConfig types.ProviderConfig, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc

MakeDeploy creates a handler for deploying functions

func MakeExtractFunctionMiddleWare

func MakeExtractFunctionMiddleWare(
	getVars func(*http.Request) map[string]string,
	next http.HandlerFunc) http.HandlerFunc

MakeExtractFunctionMiddleWare returns a middleware handler which validates the presence of the function name in the URI query.

func MakeHealthHandler

func MakeHealthHandler() http.HandlerFunc

MakeHealthHandler returns 200/OK when healthy

func MakeInfo

func MakeInfo(logger hclog.Logger, stats metrics.StatsD, version string) http.HandlerFunc

MakeInfo creates handler for /system/info endpoint

func MakeProxy

func MakeProxy(config ProxyConfig) http.HandlerFunc

MakeProxy creates a proxy for HTTP web requests which can be routed to a function.

func MakeReader

func MakeReader(client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc

MakeReader implements the OpenFaaS reader handler

func MakeReplicationReader

func MakeReplicationReader(client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc

MakeReplicationReader creates a replication reader handler

func MakeReplicationWriter

func MakeReplicationWriter(client nomad.Job, logger hclog.Logger, stats metrics.StatsD) http.HandlerFunc

MakeReplicationWriter creates a handler for scaling functions

Types

type HTTPProxyClient

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

HTTPProxyClient allows the calling of functions

func MakeProxyClient

func MakeProxyClient(timeout time.Duration, l hclog.Logger) *HTTPProxyClient

MakeProxyClient creates a new HTTPProxyClient

func (*HTTPProxyClient) CallAndReturnResponse

func (pc *HTTPProxyClient) CallAndReturnResponse(address string, body []byte, headers http.Header) (
	[]byte, http.Header, error)

CallAndReturnResponse calls the function and returns the response

func (*HTTPProxyClient) GetFunctionName

func (pc *HTTPProxyClient) GetFunctionName(r *http.Request) string

GetFunctionName returns the name of the function from the request vars

type MockProxyClient

type MockProxyClient struct {
	mock.Mock
}

MockProxyClient is a mock implementation of the ProxyClient

func (*MockProxyClient) CallAndReturnResponse

func (mp *MockProxyClient) CallAndReturnResponse(address string, body []byte, h http.Header) (
	[]byte, http.Header, error)

CallAndReturnResponse returns a mock response

func (*MockProxyClient) GetFunctionName

func (mp *MockProxyClient) GetFunctionName(r *http.Request) string

type Proxy

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

Proxy is a http.Handler which implements the ability to call a downstream function

func (*Proxy) ServeHTTP

func (p *Proxy) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type ProxyClient

type ProxyClient interface {
	GetFunctionName(*http.Request) string
	CallAndReturnResponse(address string, body []byte, headers http.Header) ([]byte, http.Header, error)
}

ProxyClient defines the interface for a client which calls faas functions

type ProxyConfig

type ProxyConfig struct {
	Client   ProxyClient
	Resolver consul.ServiceResolver
	Logger   hclog.Logger
	StatsD   *statsd.Client
	Timeout  time.Duration
}