graceful

package module

v0.0.0-...-4b32062 Latest Latest Go to latest Published: Jul 19, 2017 License: Apache-2.0 Imports: 5 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ltick/tick-graceful

Links

Open Source Insights

README ¶

tick-graceful

graceful

Documentation ¶

Overview ¶

Package gracehttp provides easy to use graceful restart functionality for HTTP server.

Index ¶

func Run(addr string, timeout time.Duration, n http.Handler, logFunc LogFunc)
type BeforeShutdownFunc
type ConnStateFunc
type Graceful
type GracefulBuilder
- func New() GracefulBuilder
type LogFunc
type ShutdownInitiatedFunc

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(addr string, timeout time.Duration, n http.Handler, logFunc LogFunc)

Run serves the http.Handler with graceful shutdown enabled.

timeout is the duration to wait until killing active requests and stopping the server. If timeout is 0, the server never times out. It waits for all active requests to finish.

Types ¶

type BeforeShutdownFunc ¶

type BeforeShutdownFunc func() bool

type ConnStateFunc ¶

type ConnStateFunc func(net.Conn, http.ConnState)

type Graceful ¶

type Graceful struct {
	Server    *libGraceful.Server
	Interrupt chan os.Signal
}

func (*Graceful) ListenAndServe ¶

func (g *Graceful) ListenAndServe() error

func (*Graceful) ListenAndServeTLS ¶

func (g *Graceful) ListenAndServeTLS(certFile, keyFile string) error

func (*Graceful) Serve ¶

func (g *Graceful) Serve(listener net.Listener) error

type GracefulBuilder ¶

type GracefulBuilder interface {
	Server(server *http.Server) GracefulBuilder
	Timeout(timeout time.Duration) GracefulBuilder
	LogFunc(logFunc LogFunc) GracefulBuilder
	ConnState(connStateFunc ConnStateFunc) GracefulBuilder
	BeforeShutdown(beforeShutdownFunc BeforeShutdownFunc) GracefulBuilder
	ShutdownInitiated(shutdownInitiatedFunc ShutdownInitiatedFunc) GracefulBuilder
	Interrupt(interrupt chan os.Signal) GracefulBuilder
	Build() *Graceful
}

func New ¶

func New() GracefulBuilder

type LogFunc ¶

type LogFunc func(format string, args ...interface{})

type ShutdownInitiatedFunc ¶

type ShutdownInitiatedFunc func()

Source Files ¶

View all Source files

graceful.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL