KMS
KMS(Killing Me Softly) is a library that aids in graceful shutdown of a process/application.
Why does this even exist? Aren't there other graceful shutdown librarys?
Sure there are other libraries, but they are focused on handling graceful shutdown a specific portion of code such as graceful shutdown of an http server, but this library allows you to glue together multiple unrelated(or related) services running within the same process/application.
Doesn't Go 1.8 handle graceful shutdown?
Yes and No, it does not yet handle Hijacked connections, like WebSockets, see:
but this package does; furthermore this package isn't just for graceful http shutdown but graceful shutdown of anything and everything.
When Go 1.8 comes out I will transparently make changes to let the std lib handle idle connections as it has lower level access to them, but continue to handle Hijacked connections.
Installation
Use go get
go get -u github.com/go-playground/kmsBuilt In
There are a few built in graceful shutdown helpers using the kms package for:
- TCP
- Unix Sockets
- HTTP(S) graceful shutdown.
Examples
see here for more
package main
import (
"net/http"
"time"
"github.com/go-playground/kms"
"github.com/go-playground/kms/kmsnet/kmshttp"
)
func main() {
// listen for shutdown signal(s) with timeout, non-blocking
kms.ListenTimeout(false, time.Minute*3)
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("Home"))
})
kmshttp.ListenAndServe(":3007", nil)
}Package Versioning
I'm jumping on the vendoring bandwagon, you should vendor this package as I will not be creating different version with gopkg.in like allot of my other libraries.
Why? because my time is spread pretty thin maintaining all of the libraries I have + LIFE, it is so freeing not to worry about it and will help me keep pouring out bigger and better things for you the community.
I am open versioning with gopkg.in should anyone request it, but this should be stable going forward.
Licenses
- MIT License (MIT), Copyright (c) 2016 Dean Karn