gracefulshutdown

Documentation

Index

• Constants
• Variables
• func ShutdownWithError(err error)
• type ParametersDefinition

Constants

const PluginName = "GracefulShutdown"

PluginName is the name of the graceful shutdown plugin.

Variables

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the graceful shutdown plugin.

var (
	// Plugin is the plugin instance of the graceful shutdown plugin.
	Plugin *node.Plugin
)

Functions

func ShutdownWithError

func ShutdownWithError(err error)

ShutdownWithError prints out an error message and shuts down the default daemon instance.

Types

type ParametersDefinition

type ParametersDefinition struct {
	// WaitToKillTime is the maximum amount of time to wait for background processes to terminate.
	WaitToKillTime time.Duration `default:"120s" usage:"the maximum amount of time to wait for background processes to terminate"`
}

ParametersDefinition contains the definition of configuration parameters used by the graceful shutdown plugin.