warmup

Documentation

Overview

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

All registered hooks should be optional. The warmup stage can be skipped.

Index

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

Functions

func InstallHandlersDeprecated

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

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

It is deprecated. Do not use. On GAEv1 it is called by the framework code. On GAEv2 or on GKE use NewModuleFromFlags() and register the warmup module when starting the server.

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.