listener

README

zero-downtime-listener

A simple package to create zero downtime listener.

Usage

Standard http package:

listeners, err := listener.NewListeners([]string{":8080"})
if err != nil {
    log.Fatalln(err)
}
http.Serve(listeners[0], nil)
listener.Wait() //Wait for the accepted connections running complete

Gin framework:

listeners, err := listener.NewListeners([]string{":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(listeners[0])
listener.Wait() //Wait for the accepted connections running complete

Close listeners:

listener.Close()

Restart command:

kill -HUP PID

Thanks:

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

Documentation

Index

• Variables
• func Close()
• func Wait()
• type Connection
  • func (c *Connection) Close() error
• type Listener
  • func NewListeners(addresses ...string) ([]*Listener, error)
  • func (l *Listener) Accept() (net.Conn, error)
  • func (l *Listener) Close() error

Variables

var (
	SigChildSuccess   = syscall.Signal(12)
	SigRequestRestart = syscall.SIGHUP

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

Functions

func Close

func Close()

func Wait

func Wait()

Types

type Connection

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

func (*Connection) Close

func (c *Connection) Close() error

type Listener

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

func NewListeners

func NewListeners(addresses ...string) ([]*Listener, error)

func (*Listener) Accept

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

func (*Listener) Close

func (l *Listener) Close() error