web

Documentation

Overview

Package web contains a small web framework extension.

Index

• func GetTime(ctx context.Context) time.Time
• func GetTraceID(ctx context.Context) string
• func IsShutdown(err error) bool
• func NewShutdownError(message string) error
• func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error
• type App
  • func NewApp(shutdown chan os.Signal, mw ...MidHandler) *App
  • func (a *App) HandleFunc(pattern string, handler Handler, mw ...MidHandler)
  • func (a *App) HandleFuncNoMiddleware(pattern string, handler Handler, mw ...MidHandler)
  • func (a *App) SignalShutdown()
• type Handler
• type MidHandler
• type Values
  • func GetValues(ctx context.Context) *Values

Functions

func GetTime

func GetTime(ctx context.Context) time.Time

GetTime returns the time from the context.

func GetTraceID

func GetTraceID(ctx context.Context) string

GetTraceID returns the trace id from the context.

func IsShutdown

func IsShutdown(err error) bool

IsShutdown checks to see if the shutdown error is contained in the specified error value.

func NewShutdownError

func NewShutdownError(message string) error

NewShutdownError returns an error that causes the framework to signal a graceful shutdown.

func Respond

func Respond(ctx context.Context, w http.ResponseWriter, data any, statusCode int) error

Respond sends a response to the client.

Types

type App

type App struct {
	*http.ServeMux
	// contains filtered or unexported fields
}

App is the entrypoint into our application and what configures our context object for each of our http handlers. Feel free to add any configuration data/logic on this App struct.

func NewApp

func NewApp(shutdown chan os.Signal, mw ...MidHandler) *App

NewApp creates an App value that handle a set of routes for the application.

func (*App) HandleFunc

func (a *App) HandleFunc(pattern string, handler Handler, mw ...MidHandler)

HandleFunc sets a handler function for a given HTTP method and path pair to the application server mid.

func (*App) HandleFuncNoMiddleware

func (a *App) HandleFuncNoMiddleware(pattern string, handler Handler, mw ...MidHandler)

HandleFuncNoMiddleware sets a handler function for a given HTTP method and path pair to the application server mux with no middleware.

func (*App) SignalShutdown

func (a *App) SignalShutdown()

SignalShutdown is used to gracefully shut down the app when an integrity issue is identified.

type Handler

type Handler func(ctx context.Context, w http.ResponseWriter, r *http.Request) error

A Handler is a type that handles a http request within our own little mini framework.

type MidHandler

type MidHandler func(Handler) Handler

MidHandler is a handler function designed to run code before and/or after another Handler. It is designed to remove boilerplate or other concerns not direct to any given app Handler.

type Values

type Values struct {
	TraceID    string
	Now        time.Time
	StatusCode int
}

Values represent state for each request.

func GetValues

func GetValues(ctx context.Context) *Values

GetValues returns the values from the context.