http

Documentation

Index

• func DefaultMiddleware(path string, next http.HandlerFunc) http.HandlerFunc
• func RecoveryMiddleware(next http.HandlerFunc) http.HandlerFunc
• func TracingMiddleware(path string, next http.HandlerFunc) http.HandlerFunc
• type Component
  • func New(oo ...Option) (*Component, error)
  • func (s *Component) Run(ctx context.Context) error
  • func (s *Component) Shutdown(ctx context.Context) error
• type HealthCheckFunc
• type HealthStatus
• type Option
  • func HealthCheck(hcf HealthCheckFunc) Option
  • func Port(port int) Option
  • func Routes(rr []Route) Option
• type Route
  • func NewRoute(p string, m string, pr sync.ProcessorFunc, trace bool) Route
  • func NewRouteRaw(p string, m string, h http.HandlerFunc) Route

Functions

func DefaultMiddleware

func DefaultMiddleware(path string, next http.HandlerFunc) http.HandlerFunc

DefaultMiddleware which handles Logging and Recover middleware

func RecoveryMiddleware

func RecoveryMiddleware(next http.HandlerFunc) http.HandlerFunc

RecoveryMiddleware for recovering from failed requests

func TracingMiddleware

func TracingMiddleware(path string, next http.HandlerFunc) http.HandlerFunc

TracingMiddleware for handling tracing and metrics

Types

type Component

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

Component implementation of HTTP.

func New

func New(oo ...Option) (*Component, error)

New returns a new component.

func (*Component) Run

func (s *Component) Run(ctx context.Context) error

Run starts the HTTP server.

func (*Component) Shutdown

func (s *Component) Shutdown(ctx context.Context) error

Shutdown the component.

type HealthCheckFunc

type HealthCheckFunc func() HealthStatus

HealthCheckFunc defines a function for implementing a health check.

type HealthStatus

type HealthStatus int

HealthStatus type represanting the health of a component.

const (
	// Initializing represents a state before the component is Healthy.
	Initializing HealthStatus = 0
	// Healthy represents a state defining a healthy state.
	Healthy HealthStatus = 1
	// Unhealthy represents a state defining a unhealthy state.
	Unhealthy HealthStatus = 2
)

type Option

type Option func(*Component) error

Option defines a option for the HTTP service.

func HealthCheck

func HealthCheck(hcf HealthCheckFunc) Option

HealthCheck option for setting the health check function.

func Port

func Port(port int) Option

Port option for setting the ports of the http service.

func Routes

func Routes(rr []Route) Option

Routes option for setting the routes of the http service.

type Route

type Route struct {
	Pattern string
	Method  string
	Handler http.HandlerFunc
	Trace   bool
}

Route definition

func NewRoute

func NewRoute(p string, m string, pr sync.ProcessorFunc, trace bool) Route

NewRoute returns a new route from a generic handler

func NewRouteRaw

func NewRouteRaw(p string, m string, h http.HandlerFunc) Route

NewRouteRaw returns a new route from a HTTP handler