gracefulshutdown

Documentation

Index

• Constants
• Variables
• func Plugin() *node.Plugin
• func ShutdownWithError(err error)
• type ParametersDefinition

Constants

const PluginName = "Graceful Shutdown"

PluginName is the name of the graceful shutdown plugin.

Variables

var Parameters = &ParametersDefinition{}

Parameters contains the configuration parameters of the graceful shutdown plugin.

Functions

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

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 (in seconds) to wait for background processes to terminate.
	WaitToKillTime int `default:"120" usage:"the maximum amount of time (in seconds) to wait for background processes to terminate"`
}

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