service: go fmt comments

This commit is contained in:
Daniel Theophanes
2024-06-13 08:31:55 -05:00
parent 9832e01049
commit 4ac50d86f3
7 changed files with 86 additions and 51 deletions

View File

@@ -16,6 +16,7 @@ import (
var logger service.Logger var logger service.Logger
// Program structures. // Program structures.
//
// Define Start and Stop methods. // Define Start and Stop methods.
type program struct { type program struct {
exit chan struct{} exit chan struct{}
@@ -54,6 +55,7 @@ func (p *program) Stop(s service.Service) error {
} }
// Service setup. // Service setup.
//
// Define service config. // Define service config.
// Create the service. // Create the service.
// Setup the logger. // Setup the logger.

View File

@@ -167,41 +167,69 @@ func New(i Interface, c *Config) (Service, error) {
} }
// KeyValue provides a list of system specific options. // KeyValue provides a list of system specific options.
// * OS X //
// - OS X
//
// - LaunchdConfig string () - Use custom launchd config. // - LaunchdConfig string () - Use custom launchd config.
//
// - KeepAlive bool (true) - Prevent the system from stopping the service automatically. // - KeepAlive bool (true) - Prevent the system from stopping the service automatically.
//
// - RunAtLoad bool (false) - Run the service after its job has been loaded. // - RunAtLoad bool (false) - Run the service after its job has been loaded.
//
// - SessionCreate bool (false) - Create a full user session. // - SessionCreate bool (false) - Create a full user session.
// //
// * Solaris // - Solaris
//
// - Prefix string ("application") - Service FMRI prefix. // - Prefix string ("application") - Service FMRI prefix.
// //
// * POSIX // - POSIX
//
// - UserService bool (false) - Install as a current user service. // - UserService bool (false) - Install as a current user service.
//
// - SystemdScript string () - Use custom systemd script. // - SystemdScript string () - Use custom systemd script.
//
// - UpstartScript string () - Use custom upstart script. // - UpstartScript string () - Use custom upstart script.
//
// - SysvScript string () - Use custom sysv script. // - SysvScript string () - Use custom sysv script.
//
// - OpenRCScript string () - Use custom OpenRC script. // - OpenRCScript string () - Use custom OpenRC script.
//
// - RunWait func() (wait for SIGNAL) - Do not install signal but wait for this function to return. // - RunWait func() (wait for SIGNAL) - Do not install signal but wait for this function to return.
//
// - ReloadSignal string () [USR1, ...] - Signal to send on reload. // - ReloadSignal string () [USR1, ...] - Signal to send on reload.
//
// - PIDFile string () [/run/prog.pid] - Location of the PID file. // - PIDFile string () [/run/prog.pid] - Location of the PID file.
//
// - LogOutput bool (false) - Redirect StdErr & StandardOutPath to files. // - LogOutput bool (false) - Redirect StdErr & StandardOutPath to files.
//
// - Restart string (always) - How shall service be restarted. // - Restart string (always) - How shall service be restarted.
//
// - SuccessExitStatus string () - The list of exit status that shall be considered as successful, // - SuccessExitStatus string () - The list of exit status that shall be considered as successful,
// in addition to the default ones. // in addition to the default ones.
//
// - LogDirectory string(/var/log) - The path to the log files directory // - LogDirectory string(/var/log) - The path to the log files directory
// //
// * Linux (systemd) // - Linux (systemd)
//
// - LimitNOFILE int (-1) - Maximum open files (ulimit -n) // - LimitNOFILE int (-1) - Maximum open files (ulimit -n)
// (https://serverfault.com/questions/628610/increasing-nproc-for-processes-launched-by-systemd-on-centos-7) // (https://serverfault.com/questions/628610/increasing-nproc-for-processes-launched-by-systemd-on-centos-7)
// * Windows //
// - Windows
//
// - DelayedAutoStart bool (false) - After booting, start this service after some delay. // - DelayedAutoStart bool (false) - After booting, start this service after some delay.
//
// - Password string () - Password to use when interfacing with the system service manager. // - Password string () - Password to use when interfacing with the system service manager.
//
// - Interactive bool (false) - The service can interact with the desktop. (more information https://docs.microsoft.com/en-us/windows/win32/services/interactive-services) // - Interactive bool (false) - The service can interact with the desktop. (more information https://docs.microsoft.com/en-us/windows/win32/services/interactive-services)
//
// - DelayedAutoStart bool (false) - after booting start this service after some delay. // - DelayedAutoStart bool (false) - after booting start this service after some delay.
//
// - StartType string ("automatic") - Start service type. (automatic | manual | disabled) // - StartType string ("automatic") - Start service type. (automatic | manual | disabled)
//
// - OnFailure string ("restart" ) - Action to perform on service failure. (restart | reboot | noaction) // - OnFailure string ("restart" ) - Action to perform on service failure. (restart | reboot | noaction)
//
// - OnFailureDelayDuration string ( "1s" ) - Delay before restarting the service, time.Duration string. // - OnFailureDelayDuration string ( "1s" ) - Delay before restarting the service, time.Duration string.
//
// - OnFailureResetPeriod int ( 10 ) - Reset period for errors, seconds. // - OnFailureResetPeriod int ( 10 ) - Reset period for errors, seconds.
type KeyValue map[string]interface{} type KeyValue map[string]interface{}

View File

@@ -1,3 +1,4 @@
//go:build aix
// +build aix // +build aix
// Copyright 2015 Daniel Theophanes. // Copyright 2015 Daniel Theophanes.

View File

@@ -1,3 +1,4 @@
//go:build go1.8
// +build go1.8 // +build go1.8
package service package service

View File

@@ -2,6 +2,7 @@
// Use of this source code is governed by a zlib-style // Use of this source code is governed by a zlib-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
//go:build !su
// +build !su // +build !su
package service_test package service_test

View File

@@ -3,6 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// This needs to be run as root/admin hence the reason there is a build tag // This needs to be run as root/admin hence the reason there is a build tag
//go:build su
// +build su // +build su
package service_test package service_test

View File

@@ -2,6 +2,7 @@
// Use of this source code is governed by a zlib-style // Use of this source code is governed by a zlib-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
//go:build darwin || dragonfly || freebsd || linux || nacl || netbsd || openbsd || solaris
// +build darwin dragonfly freebsd linux nacl netbsd openbsd solaris // +build darwin dragonfly freebsd linux nacl netbsd openbsd solaris
package service_test package service_test