graceful

README

graceful

A simple package for creating socket listeners to restart servers gracefully.

Installation

Import the package by using go mod:

import "github.com/jqqjj/graceful"

Usage

Use in net/http:

ln, err := graceful.NewGraceListener(":8080")
if err != nil {
    log.Fatalln(err)
}
http.Serve(ln, nil)

Use in gin framework:

ln, err := graceful.NewGraceListener(":8080")
if err != nil {
    log.Fatalln(err)
}

router := gin.Default()
router.GET("/", func(c *gin.Context) {
    c.String(http.StatusOK, "this is a test")
})
router.RunListener(ln)

Graceful restart:

kill -HUP PID

Run Args:

• daemon    Run app as a daemon

Features

• Will not close connections including http actively.
• Old process will not exit until all connections are completed and closed.
• Restart gracefully is not implemented on windows but you can develop and run your business codes on it.

Thanks:

• mitchellh/go-ps    Find, list, and inspect processes from Go (golang).

Documentation

Index

• Variables
• type GraceConnection
  • func NewGraceConnection(wg *sync.WaitGroup, c net.Conn) *GraceConnection
  • func (c *GraceConnection) Close() error
• type GraceListener
  • func NewGraceListener(addr string) (*GraceListener, error)
  • func (l *GraceListener) Accept() (net.Conn, error)
  • func (l *GraceListener) Close() error

Variables

var (
	Logger       *log.Logger
	ArgDaemonKey = "daemon"

	ForkTimeout    = time.Second * 10
	ForkTimeoutErr = errors.New("forking timeout")

	SigGraceFinish  = syscall.Signal(12)
	SigGraceRestart = syscall.SIGHUP
)

Types

type GraceConnection

type GraceConnection struct {
	net.Conn
	// contains filtered or unexported fields
}

func NewGraceConnection

func NewGraceConnection(wg *sync.WaitGroup, c net.Conn) *GraceConnection

func (*GraceConnection) Close

func (c *GraceConnection) Close() error

type GraceListener

type GraceListener struct {
	net.Listener
	// contains filtered or unexported fields
}

func NewGraceListener

func NewGraceListener(addr string) (*GraceListener, error)

func (*GraceListener) Accept

func (l *GraceListener) Accept() (net.Conn, error)

func (*GraceListener) Close

func (l *GraceListener) Close() error