server

package

Go to main page

Versions in this module

v0

v0.9.2

Dec 19, 2025

Changes in this version

+ const DefaultHealthCheckPort

+ const LoadBalancerAffinityOptOutHeader

+ const LoadBalancerTargetHeader

type Config

+ HTTP3Enabled bool

+ type CookieScope struct

+ func NewCookieScope(pathPrefix string, host string) *CookieScope

+ func (cs *CookieScope) ApplyToHeader(header http.Header)

type DeployArgs

+ DeploymentOptions DeploymentOptions

+ type DeploymentOptions struct

+ DeployTimeout time.Duration

+ DrainTimeout time.Duration

+ Force bool

type HealthCheckConfig

+ Host string

+ Port int

type RolloutDeployArgs

+ DeploymentOptions DeploymentOptions

type ServiceMap

+ func (m *ServiceMap) DefaultTLSHostname() string

type ServiceOptions

+ CanonicalHost string

type Target

+ func (t *Target) Address() string

type TargetOptions

+ ScopeCookiePaths bool

v0.9.1

May 14, 2025

v0.9.0

May 6, 2025

Changes in this version

+ const DefaultWriterAffinityTimeout

+ const LoadBalancerWriteCookieName

+ var ErrorNoHealthyTargets = errors.New("no healthy targets")

+ func EnsureTrailingSlash(path string) string

+ func NormalizeHosts(hosts []string) []string

+ func NormalizePathPrefixes(pathPrefixes []string) []string

+ func RoutingContext(r *http.Request) *routingContext

type Config

+ MetricsPort int

type DeployArgs

+ ReaderURLs []string

+ TargetURLs []string

+ type LoadBalancer struct

+ func NewLoadBalancer(targets TargetList, writerAffinityTimeout time.Duration, ...) *LoadBalancer

+ func (lb *LoadBalancer) Dispose()

+ func (lb *LoadBalancer) DrainAll(timeout time.Duration)

+ func (lb *LoadBalancer) MarkAllHealthy()

+ func (lb *LoadBalancer) ReadTargets() TargetList

+ func (lb *LoadBalancer) StartRequest(w http.ResponseWriter, r *http.Request) func()

+ func (lb *LoadBalancer) TargetStateChanged(target *Target)

+ func (lb *LoadBalancer) Targets() TargetList

+ func (lb *LoadBalancer) WaitUntilHealthy(timeout time.Duration) error

+ func (lb *LoadBalancer) WriteTargets() TargetList

type RolloutDeployArgs

+ ReaderURLs []string

+ TargetURLs []string

type Router

+ func (r *Router) DeployService(name string, targetURLs, readerURLs []string, options ServiceOptions, ...) error

+ func (r *Router) SetRolloutTargets(name string, targetURLs, readerURLs []string, deployTimeout time.Duration, ...) error

type Service

+ func (s *Service) Dispose()

+ func (s *Service) Drain(timeout time.Duration)

+ func (s *Service) UpdateLoadBalancer(lb *LoadBalancer, slot TargetSlot) *LoadBalancer

type ServiceDescription

+ Path string

type ServiceMap

+ func NewServiceMap() *ServiceMap

+ func (m *ServiceMap) All() iter.Seq2[string, *Service]

+ func (m *ServiceMap) CheckAvailability(name string, options ServiceOptions) *Service

+ func (m *ServiceMap) Get(name string) *Service

+ func (m *ServiceMap) Remove(name string)

+ func (m *ServiceMap) ServiceForHost(host string) *Service

+ func (m *ServiceMap) ServiceForRequest(req *http.Request) (*Service, string)

+ func (m *ServiceMap) Set(service *Service)

type ServiceOptions

+ Hosts []string

+ PathPrefixes []string

+ ReadTargetsAcceptWebsockets bool

+ StripPrefix bool

+ WriterAffinityTimeout time.Duration

+ func (so *ServiceOptions) Normalize()

+ func (so *ServiceOptions) WithHosts(hosts []string) ServiceOptions

+ func (so *ServiceOptions) WithPathPrefixes(pathPrefixes []string) ServiceOptions

type Target

+ func NewReadOnlyTarget(targetURL string, options TargetOptions) (*Target, error)

+ func (t *Target) ReadOnly() bool

+ func (t *Target) State() TargetState

+ type TargetList []*Target

+ func NewTargetList(targetURLs, readerURLs []string, options TargetOptions) (TargetList, error)

+ func (tl TargetList) BeginHealthChecks(stateConsumer TargetStateConsumer)

+ func (tl TargetList) HasReaders() bool

+ func (tl TargetList) Names() []string

+ func (tl TargetList) StopHealthChecks()

type TargetOptions

+ func (to *TargetOptions) IsHealthCheckRequest(r *http.Request) bool

type TargetState

+ const TargetStateUnhealthy

+ type TargetStateConsumer interface

+ TargetStateChanged func(*Target)

v0.8.7

Mar 12, 2025

Changes in this version

type ServiceOptions

+ TLSRedirect bool

v0.8.6

Mar 7, 2025

v0.8.5

Feb 12, 2025

Changes in this version

+ func PerformConcurrently(fns ...func())

type ServiceOptions

+ TLSDisableRedirect bool

v0.8.4

Nov 26, 2024

Changes in this version

+ var ErrorHealthCheckRequestTimedOut = errors.New("Request timed out")

+ var ErrorHealthCheckUnexpectedStatus = errors.New("Unexpected status")

v0.8.3

Nov 25, 2024

Changes in this version

+ const StatusClientClosedRequest

+ func WithRequestStartMiddleware(next http.Handler) http.Handler

+ type RequestStartMiddleware struct

+ func (h *RequestStartMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

v0.8.2

Oct 25, 2024

v0.8.1

Oct 9, 2024

v0.8.0

Oct 6, 2024

Changes in this version

+ var ErrorAutomaticTLSDoesNotSupportWildcards = errors.New("automatic TLS does not support wildcards")

+ var ErrorUnableToLoadCertificate = errors.New("unable to load certificate")

+ var ErrorUnableToLoadErrorPages = errors.New("unable to load error pages")

+ type CertManager interface

+ GetCertificate func(hello *tls.ClientHelloInfo) (*tls.Certificate, error)

+ HTTPHandler func(handler http.Handler) http.Handler

type HostServiceMap

+ func (m HostServiceMap) ServiceForHost(host string) *Service

type ServiceOptions

+ TLSCertificatePath string

+ TLSPrivateKeyPath string

+ type StaticCertManager struct

+ func NewStaticCertManager(tlsCertificateFilePath, tlsPrivateKeyFilePath string) (*StaticCertManager, error)

+ func (m *StaticCertManager) GetCertificate(*tls.ClientHelloInfo) (*tls.Certificate, error)

+ func (m *StaticCertManager) HTTPHandler(handler http.Handler) http.Handler

v0.7.0

Sep 30, 2024

v0.6.0

Sep 25, 2024

Changes in this version

type DeployArgs

+ Hosts []string

type HostServiceMap

+ func (m HostServiceMap) CheckHostAvailability(name string, hosts []string) *Service

+ type ServiceMap map[string]*Service

+ func (m ServiceMap) HostServices() HostServiceMap

type ServiceOptions

+ TLSEnabled bool

v0.5.0

Sep 23, 2024

v0.4.0

Sep 19, 2024

v0.3.0

Sep 18, 2024

v0.2.0

Sep 17, 2024

v0.1.0

Sep 16, 2024

Changes in this version

+ const ACMEStagingDirectoryURL

+ const B

+ const DefaultDeployTimeout

+ const DefaultDrainTimeout

+ const DefaultHealthCheckInterval

+ const DefaultHealthCheckPath

+ const DefaultHealthCheckTimeout

+ const DefaultHttpPort

+ const DefaultHttpsPort

+ const DefaultMaxMemoryBufferSize

+ const DefaultMaxRequestBodySize

+ const DefaultMaxResponseBodySize

+ const DefaultPauseTimeout

+ const DefaultStopMessage

+ const DefaultTargetTimeout

+ const GB

+ const KB

+ const MB

+ const MaxIdleConnsPerHost

+ const ProxyBufferSize

+ const RolloutCookieName

+ var ErrMaximumSizeExceeded = errors.New("maximum size exceeded")

+ var ErrWriteAfterRead = errors.New("write after read")

+ var ErrorDraining = errors.New("target is draining")

+ var ErrorHostInUse = errors.New("host is used by another service")

+ var ErrorInvalidHostPattern = errors.New("invalid host pattern")

+ var ErrorNoServerName = errors.New("no server name provided")

+ var ErrorRolloutTargetNotSet = errors.New("rollout target not set")

+ var ErrorServiceNotFound = errors.New("service not found")

+ var ErrorTargetFailedToBecomeHealthy = errors.New("target failed to become healthy")

+ var ErrorUnknownServerName = errors.New("unknown server name")

+ func LoggingRequestContext(r *http.Request) *loggingRequestContext

+ func NewBufferedReadCloser(r io.ReadCloser, maxBytes, maxMemBytes int64) (io.ReadCloser, error)

+ func SetErrorResponse(w http.ResponseWriter, r *http.Request, statusCode int, templateArguments any)

+ func WithErrorPageMiddleware(pages fs.FS, root bool, next http.Handler) http.Handler

+ func WithLoggingMiddleware(logger *slog.Logger, httpPort, httpsPort int, next http.Handler) http.Handler

+ func WithRequestBufferMiddleware(maxMemBytes, maxBytes int64, next http.Handler) http.Handler

+ func WithRequestIDMiddleware(next http.Handler) http.Handler

+ func WithResponseBufferMiddleware(maxMemBytes, maxBytes int64, next http.Handler) http.Handler

+ type Buffer struct

+ func NewBufferedWriteCloser(maxBytes, maxMemBytes int64) *Buffer

+ func (b *Buffer) Close() error

+ func (b *Buffer) Overflowed() bool

+ func (b *Buffer) Read(p []byte) (n int, err error)

+ func (b *Buffer) Send(w io.Writer) error

+ func (b *Buffer) Write(p []byte) (int, error)

+ type BufferPool struct

+ func NewBufferPool(bufferSize int64) *BufferPool

+ func (b *BufferPool) Get() []byte

+ func (b *BufferPool) Put(content []byte)

+ type CommandHandler struct

+ func NewCommandHandler(router *Router) *CommandHandler

+ func (h *CommandHandler) Close() error

+ func (h *CommandHandler) Deploy(args DeployArgs, reply *bool) error

+ func (h *CommandHandler) List(args bool, reply *ListResponse) error

+ func (h *CommandHandler) Pause(args PauseArgs, reply *bool) error

+ func (h *CommandHandler) Remove(args DeployArgs, reply *bool) error

+ func (h *CommandHandler) Resume(args ResumeArgs, reply *bool) error

+ func (h *CommandHandler) RolloutDeploy(args RolloutDeployArgs, reply *bool) error

+ func (h *CommandHandler) RolloutSet(args RolloutSetArgs, reply *bool) error

+ func (h *CommandHandler) RolloutStop(args RolloutStopArgs, reply *bool) error

+ func (h *CommandHandler) Start(socketPath string) error

+ func (h *CommandHandler) Stop(args StopArgs, reply *bool) error

+ type Config struct

+ AlternateConfigDir string

+ Bind string

+ HttpPort int

+ HttpsPort int

+ func (c Config) CertificatePath() string

+ func (c Config) SocketPath() string

+ func (c Config) StatePath() string

+ type DeployArgs struct

+ DeployTimeout time.Duration

+ DrainTimeout time.Duration

+ Host string

+ Service string

+ ServiceOptions ServiceOptions

+ TargetOptions TargetOptions

+ TargetURL string

+ type ErrorPageMiddleware struct

+ func (h *ErrorPageMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HealthCheck struct

+ func NewHealthCheck(consumer HealthCheckConsumer, endpoint *url.URL, interval time.Duration, ...) *HealthCheck

+ func (hc *HealthCheck) Close()

+ type HealthCheckConfig struct

+ Interval time.Duration

+ Path string

+ Timeout time.Duration

+ type HealthCheckConsumer interface

+ HealthCheckCompleted func(success bool)

+ type HostServiceMap map[string]*Service

+ type ListResponse struct

+ Targets ServiceDescriptionMap

+ type LoggingMiddleware struct

+ func (h *LoggingMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type PauseArgs struct

+ DrainTimeout time.Duration

+ PauseTimeout time.Duration

+ Service string

+ type PauseController struct

+ FailAfter time.Duration

+ State PauseState

+ StopMessage string

+ func NewPauseController() *PauseController

+ func (p *PauseController) GetState() PauseState

+ func (p *PauseController) GetStopMessage() string

+ func (p *PauseController) Pause(failAfter time.Duration) error

+ func (p *PauseController) Resume() error

+ func (p *PauseController) Stop(message string) error

+ func (p *PauseController) UnmarshalJSON(data []byte) error

+ func (p *PauseController) Wait() (PauseWaitAction, string)

+ type PauseState int

+ const PauseStatePaused

+ const PauseStateRunning

+ const PauseStateStopped

+ func (ps PauseState) String() string

+ type PauseWaitAction int

+ const PauseWaitActionProceed

+ const PauseWaitActionStopped

+ const PauseWaitActionTimedOut

+ type RemoveArgs struct

+ Service string

+ type RequestBufferMiddleware struct

+ func (h *RequestBufferMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type RequestIDMiddleware struct

+ func (h *RequestIDMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type ResponseBufferMiddleware struct

+ func (h *ResponseBufferMiddleware) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type ResumeArgs struct

+ Service string

+ type RolloutController struct

+ Allowlist []string

+ Percentage int

+ PercentageSplitPoint float64

+ func NewRolloutController(percentage int, allowlist []string) *RolloutController

+ func (rc *RolloutController) RequestUsesRolloutGroup(r *http.Request) bool

+ type RolloutDeployArgs struct

+ DeployTimeout time.Duration

+ DrainTimeout time.Duration

+ Service string

+ TargetURL string

+ type RolloutSetArgs struct

+ Allowlist []string

+ Percentage int

+ Service string

+ type RolloutStopArgs struct

+ Service string

+ type Router struct

+ func NewRouter(statePath string) *Router

+ func (r *Router) GetCertificate(hello *tls.ClientHelloInfo) (*tls.Certificate, error)

+ func (r *Router) ListActiveServices() ServiceDescriptionMap

+ func (r *Router) PauseService(name string, drainTimeout time.Duration, pauseTimeout time.Duration) error

+ func (r *Router) RemoveService(name string) error

+ func (r *Router) RestoreLastSavedState() error

+ func (r *Router) ResumeService(name string) error

+ func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (r *Router) SetRolloutSplit(name string, percent int, allowList []string) error

+ func (r *Router) SetRolloutTarget(name string, targetURL string, deployTimeout time.Duration, ...) error

+ func (r *Router) SetServiceTarget(name string, host string, targetURL string, options ServiceOptions, ...) error

+ func (r *Router) StopRollout(name string) error

+ func (r *Router) StopService(name string, drainTimeout time.Duration, message string) error

+ type Server struct

+ func NewServer(config *Config, router *Router) *Server

+ func (s *Server) HttpPort() int

+ func (s *Server) HttpsPort() int

+ func (s *Server) Start() error

+ func (s *Server) Stop()

+ type Service struct

+ func NewService(name, host string, options ServiceOptions) *Service

+ func (s *Service) ActiveTarget() *Target

+ func (s *Service) ClaimTarget(req *http.Request) (*Target, *http.Request, error)

+ func (s *Service) MarshalJSON() ([]byte, error)

+ func (s *Service) Pause(drainTimeout time.Duration, pauseTimeout time.Duration) error

+ func (s *Service) Resume() error

+ func (s *Service) RolloutTarget() *Target

+ func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (s *Service) SetRolloutSplit(percentage int, allowlist []string) error

+ func (s *Service) SetTarget(slot TargetSlot, target *Target, drainTimeout time.Duration)

+ func (s *Service) Stop(drainTimeout time.Duration, message string) error

+ func (s *Service) StopRollout() error

+ func (s *Service) UnmarshalJSON(data []byte) error

+ func (s *Service) UpdateOptions(options ServiceOptions)

+ type ServiceDescription struct

+ Host string

+ State string

+ TLS bool

+ Target string

+ type ServiceDescriptionMap map[string]ServiceDescription

+ type ServiceOptions struct

+ ACMECachePath string

+ ACMEDirectory string

+ ErrorPagePath string

+ TLSHostname string

+ func (so ServiceOptions) RequireTLS() bool

+ func (so ServiceOptions) ScopedCachePath() string

+ type StopArgs struct

+ DrainTimeout time.Duration

+ Message string

+ Service string

+ type Target struct

+ func NewTarget(targetURL string, options TargetOptions) (*Target, error)

+ func (t *Target) BeginHealthChecks()

+ func (t *Target) Drain(timeout time.Duration)

+ func (t *Target) HealthCheckCompleted(success bool)

+ func (t *Target) IsHealthCheckRequest(r *http.Request) bool

+ func (t *Target) SendRequest(w http.ResponseWriter, req *http.Request)

+ func (t *Target) StartRequest(req *http.Request) (*http.Request, error)

+ func (t *Target) StopHealthChecks()

+ func (t *Target) Target() string

+ func (t *Target) WaitUntilHealthy(timeout time.Duration) bool

+ type TargetOptions struct

+ BufferRequests bool

+ BufferResponses bool

+ ForwardHeaders bool

+ HealthCheckConfig HealthCheckConfig

+ LogRequestHeaders []string

+ LogResponseHeaders []string

+ MaxMemoryBufferSize int64

+ MaxRequestBodySize int64

+ MaxResponseBodySize int64

+ ResponseTimeout time.Duration

+ type TargetSlot int

+ const TargetSlotActive

+ const TargetSlotRollout

+ type TargetState int

+ const TargetStateAdding

+ const TargetStateDraining

+ const TargetStateHealthy

+ func (ts TargetState) String() string

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