generated from ekristen/go-project-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: bring signals package in house
- Loading branch information
Showing
6 changed files
with
122 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/* | ||
Copyright 2017 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package signals | ||
|
||
import ( | ||
"context" | ||
"os" | ||
"os/signal" | ||
|
||
"github.com/sirupsen/logrus" | ||
) | ||
|
||
var onlyOneSignalHandler = make(chan struct{}) | ||
var shutdownHandler chan os.Signal | ||
|
||
// 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. | ||
func SetupSignalHandler() <-chan struct{} { | ||
return SetupSignalContext().Done() | ||
} | ||
|
||
// 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 SetupSignalContext() context.Context { | ||
close(onlyOneSignalHandler) // panics when called twice | ||
|
||
shutdownHandler = make(chan os.Signal, 2) | ||
|
||
ctx, cancel := context.WithCancel(context.Background()) | ||
signal.Notify(shutdownHandler, shutdownSignals...) | ||
go func() { | ||
s := <-shutdownHandler | ||
logrus.Warnf("signal received: %q, canceling context...", s) | ||
cancel() | ||
s = <-shutdownHandler | ||
logrus.Warnf("second signal received: %q, exiting...", s) | ||
os.Exit(1) // second signal. Exit directly. | ||
}() | ||
|
||
return ctx | ||
} | ||
|
||
// RequestShutdown emulates a received event that is considered as shutdown signal (SIGTERM/SIGINT) | ||
// This returns whether a handler was notified | ||
func RequestShutdown() bool { | ||
if shutdownHandler != nil { | ||
select { | ||
case shutdownHandler <- shutdownSignals[0]: | ||
return true | ||
default: | ||
} | ||
} | ||
|
||
return false | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
//go:build !windows | ||
|
||
/* | ||
Copyright 2017 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package signals | ||
|
||
import ( | ||
"os" | ||
"syscall" | ||
) | ||
|
||
var shutdownSignals = []os.Signal{os.Interrupt, syscall.SIGTERM} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
/* | ||
Copyright 2017 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package signals | ||
|
||
import ( | ||
"os" | ||
) | ||
|
||
var shutdownSignals = []os.Signal{os.Interrupt} |