http

Documentation

Index

• Constants
• func ObtainCertificates(cacheDir, email, challengeType string, domains []string, useProduction bool, ...) (*tls.Config, error)
• type Middleware
• type Plugin
  • func (p *Plugin) AddMiddleware(name endure.Named, m Middleware)
  • func (p *Plugin) Available()
  • func (p *Plugin) Collects() []interface{}
  • func (p *Plugin) Init(cfg config.Configurer, rrLogger logger.Logger, server server.Server) error
  • func (p *Plugin) MetricsCollector() []prometheus.Collector
  • func (p *Plugin) Name() string
  • func (p *Plugin) Ready() status.Status
  • func (p *Plugin) Reset() error
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (p *Plugin) Status() status.Status
  • func (p *Plugin) Stop() error
  • func (p *Plugin) Workers() []*process.State

Constants

const (
	HTTP01    challenge = "http-01"
	TLSAlpn01 challenge = "tlsalpn-01"
)

const (
	// PluginName declares plugin name.
	PluginName = "http"

	// RrMode RR_HTTP env variable key (internal) if the HTTP presents
	RrMode = "RR_MODE"

	Scheme = "https"
)

Functions

func ObtainCertificates

func ObtainCertificates(cacheDir, email, challengeType string, domains []string, useProduction bool, altHTTPPort, altTLSAlpnPort int) (*tls.Config, error)

Types

type Middleware

type Middleware interface {
	Middleware(f http.Handler) http.Handler
}

Middleware interface

type Plugin

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

Plugin manages pool, http servers. The main http plugin structure

func (*Plugin) AddMiddleware

func (p *Plugin) AddMiddleware(name endure.Named, m Middleware)

AddMiddleware is base requirement for the middleware (name and Middleware)

func (*Plugin) Available

func (p *Plugin) Available()

Available interface implementation

func (*Plugin) Collects

func (p *Plugin) Collects() []interface{}

Collects collecting http middlewares

func (*Plugin) Init

func (p *Plugin) Init(cfg config.Configurer, rrLogger logger.Logger, server server.Server) error

Init must return configure svc and return true if svc hasStatus enabled. Must return error in case of misconfiguration. Services must not be used without proper configuration pushed first.

func (*Plugin) MetricsCollector

func (p *Plugin) MetricsCollector() []prometheus.Collector

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns endure.Named interface implementation

func (*Plugin) Ready

func (p *Plugin) Ready() status.Status

Ready return readiness status of the particular plugin

func (*Plugin) Reset

func (p *Plugin) Reset() error

Reset destroys the old pool and replaces it with new one, waiting for old pool to die

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

Serve serves the svc.

func (*Plugin) ServeHTTP

func (p *Plugin) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP handles connection using set of middleware and pool PSR-7 server.

func (*Plugin) Status

func (p *Plugin) Status() status.Status

Status return status of the particular plugin

func (*Plugin) Stop

func (p *Plugin) Stop() error

Stop stops the http.

func (*Plugin) Workers

func (p *Plugin) Workers() []*process.State

Workers returns slice with the process states for the workers