warmup

Documentation

Overview

Package warmup allows to register hooks executed during the server warmup.

All registered hooks should be optional. Warmup can be skipped.

Index

• func InstallHandlers(r *router.Router, base router.MiddlewareChain)
• func Register(name string, cb Callback)
• func Warmup(c context.Context) error
• type Callback

Functions

func InstallHandlers

func InstallHandlers(r *router.Router, base router.MiddlewareChain)

InstallHandlers installs HTTP handlers for warmup /_ah/* routes.

func Register

func Register(name string, cb Callback)

Register adds a callback called during warmup.

func Warmup

func Warmup(c context.Context) error

Warmup executes all registered warmup callbacks, sequentially.

Doesn't abort on individual callback errors, just collects and returns them all.

Types

type Callback

type Callback func(c context.Context) error

Callback will be called during warmup.