README
¶
Miyabi 
Graceful shutdown and restart for Go's net/http handlers.
Miyabi is pronounced me-ya-be. It means Graceful in Japanese.
Usage
It's very simple. Use miyabi.ListenAndServe instead of http.ListenAndServe.
You don't have to change other code because miyabi.ListenAndServe is compatible with http.ListenAndServe.
package main
import (
"io"
"log"
"net/http"
"github.com/naoina/miyabi"
)
// hello world, the web server
func HelloServer(w http.ResponseWriter, req *http.Request) {
io.WriteString(w, "hello, world!\n")
}
func main() {
http.HandleFunc("/hello", HelloServer)
log.Fatal(miyabi.ListenAndServe(":8080", nil))
}
See Godoc for more information.
NOTE: Miyabi is using features of Go 1.3, so doesn't work in Go 1.2.x and older versions. Also when using on Windows, it works but graceful shutdown/restart are disabled explicitly.
Graceful shutdown or restart
By default, send SIGTERM or SIGINT (Ctrl + c) signal to a process that is using Miyabi in order to graceful shutdown and send SIGHUP signal in order to graceful restart.
If you want to change the these signal, please set another signal to miyabi.ShutdownSignal and/or miyabi.RestartSignal.
In fact, miyabi.ListenAndServe and miyabi.ListenAndServeTLS will fork a process that is using Miyabi in order to achieve the graceful restart.
This means that you should write code as no side effects until the call of miyabi.ListenAndServe or miyabi.ListenAndServeTLS.
License
Miyabi is licensed under the MIT.
Documentation
¶
Overview ¶
Package miyabi provides graceful version of net/http compatible HTTP server.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ShutdownSignal is the signal for graceful shutdown. // syscall.SIGTERM by default. Please set another signal if you want. ShutdownSignal = syscall.SIGTERM // RestartSignal is the signal for graceful restart. // syscall.SIGHUP by default. Please set another signal if you want. RestartSignal = syscall.SIGHUP // Timeout specifies the timeout for terminate of the old process. // A zero value disables the timeout. Timeout = 3 * time.Minute // ServerState specifies the optional callback function that is called // when the server changes state. See the State type and associated // constants for details. ServerState func(state State) // FDEnvKey is the environment variable name of inherited file descriptor for graceful restart. FDEnvKey = "MIYABI_FD" )
Functions ¶
func ListenAndServe ¶
ListenAndServe acts like http.ListenAndServe but can be graceful shutdown and restart. If addr begin with "unix:", will listen on a Unix domain socket instead of TCP.
Types ¶
type Server ¶
Server is similar to http.Server. However, ListenAndServe, ListenAndServeTLS and Serve can be graceful shutdown and restart.
func (*Server) ListenAndServe ¶
ListenAndServe acts like http.Server.ListenAndServe but can be graceful shutdown and restart. If srv.Addr begin with "unix:", will listen on a Unix domain socket instead of TCP.
func (*Server) ListenAndServeTLS ¶
ListenAndServeTLS acts like http.Server.ListenAndServeTLS but can be graceful shutdown and restart.
func (*Server) Serve ¶
Serve acts like http.Server.Serve but can be graceful shutdown. If you want to graceful restart, use ListenAndServe or ListenAndServeTLS instead.
func (*Server) SetKeepAlivesEnabled ¶
SetKeepAlivesEnabled is same as http.Server.SetKeepAlivesEnabled.
Source Files