Documentation
¶
Index ¶
- func Command(obj Runnable, children ...any) *cobra.Command
- func Main(cmd *cobra.Command)
- func Name(obj any) string
- func RequestShutdown() bool
- func SetupSignalContext() context.Context
- func SetupSignalHandler() <-chan struct{}
- type Customizer
- type PersistentPreRunnable
- type PreRunnable
- type Runnable
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Command ¶
Command populates a cobra.Command object by extracting args from struct tags of the Runnable obj passed. The Run method is assigned to the RunE of the command. children should be either Runnable or *cobra.Command
func RequestShutdown ¶
func RequestShutdown() bool
RequestShutdown emulates a received event that is considered as shutdown signal (SIGTERM/SIGINT) This returns whether a handler was notified
func SetupSignalContext ¶
SetupSignalContext is same as SetupSignalHandler, but a context.Context is returned. Only one of SetupSignalContext and SetupSignalHandler should be called, and only can be called once.
func SetupSignalHandler ¶
func SetupSignalHandler() <-chan struct{}
SetupSignalHandler registered for SIGTERM and SIGINT. A stop channel is returned which is closed on one of these signals. If a second signal is caught, the program is terminated with exit code 1. Only one of SetupSignalContext and SetupSignalHandler should be called, and only can be called once.
Source Files
Directories