maintenance

Documentation

Overview

Package maintenance provides utilities for maintenance mode handling

Index

• type Config
• type Responder
  • func New(c Config) *Responder
  • func (r *Responder) Handle(next http.Handler) http.Handler

Types

type Config

type Config interface {
	MaintenanceMode() bool
}

Config is an interface that determines if the implementer can supply maintenance mode settings.

type Responder

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

Responder is a handle to a configured maintenance mode responder.

func New

func New(c Config) *Responder

New creates a new maintenance mode responder.

func (*Responder) Handle

func (r *Responder) Handle(next http.Handler) http.Handler

Handle will either return the maintenance mode responder (if enabled) or pass through to the next handler.