server

Documentation

Index

• Constants
• func EmitEvent(event EventName, info interface{})
• func RegisterEventHook(name string, hook EventHook) error
• type EventHook
• type EventName
• type Options
• type Server

Constants

const (
	StartupEvent         EventName = "startup"
	ShutdownEvent                  = "shutdown"
	CertRenewEvent                 = "certrenew"
	InstanceStartupEvent           = "instancestartup"
	InstanceRestartEvent           = "instancerestart"
	RegistryChangeEvent            = "registryChange"
	//ConfigChangeEvent should use the all config data as info
	ConfigChangeEvent = "configChange"
)

Functions

func EmitEvent

func EmitEvent(event EventName, info interface{})

EmitEvent executes the different hooks passing the EventType as an argument. This is a blocking function. Hook developers should use 'go' keyword if they don't want to block Caddy.

func RegisterEventHook

func RegisterEventHook(name string, hook EventHook) error

Types

type EventHook

type EventHook func(eventType EventName, eventInfo interface{}) error

type EventName

type EventName string

type Options

type Options struct {
	ServerName string
	Address    string
}

type Server

type Server interface {
	Run(graceful func())
	Shutdown()
}