http

Documentation

Overview

Package http implements helpers for HTTP requests.

Index

• Variables
• func NewHealthHandler(v ...Health) http.HandlerFunc
• func OK(rw http.ResponseWriter, _ *http.Request)
• func OKHandler() http.Handler
• func RealIP(r *http.Request) string
• type Health
• type Server
  • func NewServer(ctx context.Context, addr string, h http.Handler, opts ...SrvOptFunc) *Server
  • func (s *Server) Close() error
  • func (s *Server) Serve(errFn func(error))
  • func (s *Server) Shutdown(timeout time.Duration) error
• type SrvOptFunc
  • func WithH2C() SrvOptFunc
  • func WithReadTimeout(d time.Duration) SrvOptFunc
  • func WithTLSConfig(cfg *tls.Config) SrvOptFunc
  • func WithWriteTimeout(d time.Duration) SrvOptFunc

Variables

var DefaultHealthPath = "/health"

DefaultHealthPath is the default HTTP path for checking health.

Functions

func NewHealthHandler

func NewHealthHandler(v ...Health) http.HandlerFunc

NewHealthHandler returns a handler for application health checking.

func OK

func OK(rw http.ResponseWriter, _ *http.Request)

OK replies to the request with an HTTP 200 ok reply.

func OKHandler

func OKHandler() http.Handler

OKHandler returns a simple request handler that replies to each request with a “200 OK” reply.

func RealIP

func RealIP(r *http.Request) string

RealIP resolves the real client IP address from the request.

Types

type Health

type Health interface {
	IsHealthy() error
}

Health represents an object that can check its health.

type Server

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

Server is a convenience wrapper around the standard library HTTP server.

func NewServer

func NewServer(ctx context.Context, addr string, h http.Handler, opts ...SrvOptFunc) *Server

NewServer returns a server.

func (*Server) Close

func (s *Server) Close() error

Close closes the server.

func (*Server) Serve

func (s *Server) Serve(errFn func(error))

Serve starts the server in a non-blocking way.

func (*Server) Shutdown

func (s *Server) Shutdown(timeout time.Duration) error

Shutdown attempts to close all server connections.

type SrvOptFunc

type SrvOptFunc func(*http.Server)

SrvOptFunc represents a server option function.

func WithH2C

func WithH2C() SrvOptFunc

WithH2C allows the server to handle h2c connections.

func WithReadTimeout

func WithReadTimeout(d time.Duration) SrvOptFunc

WithReadTimeout sets the server read timeout.

func WithTLSConfig

func WithTLSConfig(cfg *tls.Config) SrvOptFunc

WithTLSConfig sets the serve tls config.

func WithWriteTimeout

func WithWriteTimeout(d time.Duration) SrvOptFunc

WithWriteTimeout sets the server write timeout.