exthttp

Documentation

Overview

Package exthttp supports setup of HTTP servers to implement the *Kit contracts. To keep the resulting binary small the net/http server is used.

Index

• func IsUnixSocketEnabled() bool
• func Listen(opts ListenOpts)
• func LogRequest(next Handler) http.Handler
• func PanicRecovery(next http.Handler) http.Handler
• func RegisterHttpHandler(path string, handler Handler)
• func RequestTimeoutHeaderAware(next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc
• func StopListen()
• func WaitForServe()
• func WriteBody(w http.ResponseWriter, response any)
• func WriteError(w http.ResponseWriter, err extension_kit.ExtensionError)
• type CertReloader
  • func NewCertReloader(certFile, keyFile string) *CertReloader
  • func (cr *CertReloader) GetCertificate(_ *tls.ClientHelloInfo) (*tls.Certificate, error)
• type Handler
  • func GetterAsHandler[T any](handler func() T) Handler
  • func IfNoneMatchHandler(etagFn func() string, delegate Handler) Handler
• type ListenOpts
• type ListenSpecification

Functions

func IsUnixSocketEnabled

func IsUnixSocketEnabled() bool

func Listen

func Listen(opts ListenOpts)

func LogRequest

func LogRequest(next Handler) http.Handler

func PanicRecovery

func PanicRecovery(next http.Handler) http.Handler

func RegisterHttpHandler

func RegisterHttpHandler(path string, handler Handler)

RegisterHttpHandler registers a handler for the given path. Also adds panic recovery and request logging around the handler.

func RequestTimeoutHeaderAware

func RequestTimeoutHeaderAware(next func(w http.ResponseWriter, r *http.Request)) http.HandlerFunc

func StopListen

func StopListen()

func WaitForServe

func WaitForServe()

func WriteBody

func WriteBody(w http.ResponseWriter, response any)

WriteBody writes the given value as the HTTP response body as JSON with status code 200.

func WriteError

func WriteError(w http.ResponseWriter, err extension_kit.ExtensionError)

WriteError writes the error as the HTTP response body with status code 500.

Types

type CertReloader

type CertReloader struct {
	CertFile string
	KeyFile  string
	// contains filtered or unexported fields
}

func NewCertReloader

func NewCertReloader(certFile, keyFile string) *CertReloader

func (*CertReloader) GetCertificate

func (cr *CertReloader) GetCertificate(_ *tls.ClientHelloInfo) (*tls.Certificate, error)

type Handler

type Handler func(w http.ResponseWriter, r *http.Request, body []byte)

func GetterAsHandler

func GetterAsHandler[T any](handler func() T) Handler

GetterAsHandler turns a getter function into a handler function. Typically used in combination with the RegisterHttpHandler function.

func IfNoneMatchHandler

func IfNoneMatchHandler(etagFn func() string, delegate Handler) Handler

type ListenOpts

type ListenOpts struct {
	// Port Default port to bind to. Can be overridden through the environment variable STEADYBIT_EXTENSION_PORT.
	Port int
}

type ListenSpecification

type ListenSpecification struct {
	Port          int      `json:"port" split_words:"true" required:"false"`
	UnixSocket    string   `json:"unixSocket" split_words:"true" required:"false"`
	TlsServerCert string   `json:"tlsServerCert" split_words:"true" required:"false"`
	TlsServerKey  string   `json:"tlsServerKey" split_words:"true" required:"false"`
	TlsClientCas  []string `json:"tlsClientCas" split_words:"true" required:"false"`
}