http

Documentation

Index

• Variables
• func New(hpf HandlerProviderFunc) service.ModuleProvider
• func OnError(w http.ResponseWriter, _ *http.Request, err string)
• type GXHttpHandler
• type GXHttpHandlerWithPaths
• type HandlerProviderFunc
• type Metrics
  • func NewMetrics(opts MetricsOptions) *Metrics
  • func (m *Metrics) Handler(h http.Handler) http.Handler
• type MetricsOptions
• type Middleware
  • func NewTimeOut(opts TimeOutOptions) *Middleware
  • func (m *Middleware) Handler(h http.Handler) http.Handler
• type ModuleConfig
• type TimeOutOptions

Variables

var ErrHandlerTimeout = errors.New("http: Handler timeout")

ErrHandlerTimeout is returned on ResponseWriter Write calls in handlers which have timed out.

Functions

func New

func New(hpf HandlerProviderFunc) service.ModuleProvider

func OnError

func OnError(w http.ResponseWriter, _ *http.Request, err string)

Types

type GXHttpHandler

type GXHttpHandler interface {
	http.Handler
}

type GXHttpHandlerWithPaths

type GXHttpHandlerWithPaths interface {
	GXHttpHandler

	GetPaths() []string
}

type HandlerProviderFunc

type HandlerProviderFunc func(driver service.ModuleDriver) (GXHttpHandler, error)

type Metrics

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

func NewMetrics

func NewMetrics(opts MetricsOptions) *Metrics

func (*Metrics) Handler

func (m *Metrics) Handler(h http.Handler) http.Handler

type MetricsOptions

type MetricsOptions struct {
	HostName    string
	ModuleName  string
	ProcessName string
	Paths       []string

	Registerer prometheus.Registerer
}

type Middleware

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

func NewTimeOut

func NewTimeOut(opts TimeOutOptions) *Middleware

func (*Middleware) Handler

func (m *Middleware) Handler(h http.Handler) http.Handler

type ModuleConfig

type ModuleConfig struct {
	modules.ModuleConfig `mapstructure:",squash"`

	ReadTimeout int64 `mapstructure:"read_timeout"`

	WriteTimeout int64 `mapstructure:"write_timeout"`

	IdleTimeout int64 `mapstructure:"idle_timeout"`

	HandlerTimeout int64 `mapstructure:"handler_timeout"`

	DisableGzipMiddleware bool `mapstructure:"disable_gzip_middleware"`
}

type TimeOutOptions

type TimeOutOptions struct {
	Timeout      time.Duration
	ErrorHandler errorHandler
}