lifecycle

Documentation

Index

• Variables
• func Init()
• func NotifyRouterReady(router *gin.Engine)
• func Register(id string, secret string, h Hook) error
• func Shutdown(ctx context.Context)
• func Start(ctx context.Context) error
• type Hook
• type RouterHook

Variables

var (
	NoExtensions bool
)

Functions

func Init

func Init()

func NotifyRouterReady

func NotifyRouterReady(router *gin.Engine)

func Register

func Register(id string, secret string, h Hook) error

Register registers a lifecycle hook. Order matters: hooks are started in registration order and shutdown in reverse order.

func Shutdown

func Shutdown(ctx context.Context)

Shutdown executes all hooks in reverse order.

func Start

func Start(ctx context.Context) error

Start executes all registered hooks in order.

Types

type Hook

type Hook interface {
	OnStart(ctx context.Context) error
	OnShutdown(ctx context.Context) error
}

type RouterHook

type RouterHook interface {
	OnRouterReady(router *gin.RouterGroup)
}