shutdown

README

shutdown

This package offers a simple way to watch OS termination signals and execute cleanup functions.
GoDoc

Install

go get -u github.com/iamken1204/shutdown

Usage

package main

import (
	"fmt"

	"github.com/iamken1204/shutdown"
)

func main() {
	fmt.Println("Starting the app.")

	srv := myServer{}
	s := shutdown.New()

	h := shutdown.NewHook(func() error {
		fmt.Println("executing my hook...")
		return nil
	})
	s.AddHook(
		h,
		shutdown.NewHook(func() error {
			fmt.Println("hook the 2nd is running")
			return nil
		}),
		srv,
	)

	s.Listen()
	fmt.Println("The app has been shut down.")
}

type myServer struct{}

func (myServer) Cleanup() error {
	fmt.Println("terminating myServer")
	return nil
}

Documentation

Index

• type Hook
  • func NewHook(fn func() error) Hook
• type Shutdown
  • func New() *Shutdown
  • func (s *Shutdown) AddHook(hooks ...Hook)
  • func (s *Shutdown) Context() context.Context
  • func (s *Shutdown) Listen()

Types

type Hook

type Hook interface {
	// Cleanup executes pre-actions before the program shuts down.
	Cleanup() error
}

Hook handles cleanup function within.

func NewHook

func NewHook(fn func() error) Hook

NewHook offers a convinient way to generate a Hook from a pure function.

type Shutdown

type Shutdown struct {
	Timeout time.Duration
	// contains filtered or unexported fields
}

Shutdown contains cleanup hooks.

func New

func New() *Shutdown

New initializes a Shutdown instance.

func (*Shutdown) AddHook

func (s *Shutdown) AddHook(hooks ...Hook)

AddHook appends given hooks.

func (*Shutdown) Context

func (s *Shutdown) Context() context.Context

Context returns Shutdown's underlying Context.

func (*Shutdown) Listen

func (s *Shutdown) Listen()

Listen blocks the program until received terminating signals, then trigger all hook functions within.