death

package module
Version: v0.0.0-...-41b1e04 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2016 License: MIT Imports: 7 Imported by: 0

README

Death Build Status

Simple library to make it easier to manage the death of your application.

Get The Library

go get github.com/vrecan/death

Use The Library

package main

import (
	DEATH "github.com/vrecan/death"
	SYS "syscall"
)

func main() {
	death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
	//when you want to block for shutdown signals
	death.WaitForDeath() // this will finish when a signal of your type is sent to your application
}
Close Other Objects On Shutdown

One simple feature of death is that it can also close other objects when shutdown starts

package main

import (
	DEATH "github.com/vrecan/death"
	SYS "syscall"
	"io"
)

func main() {
	death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
	objects := make([]io.Closer, 0)

	objects = append(objects, &NewType{}) // this will work as long as the type implements a Close method

	//when you want to block for shutdown signals
	death.WaitForDeath(objects...) // this will finish when a signal of your type is sent to your application
}

type NewType struct {
}

func (c *NewType) Close() error {
	return nil
}
Or close using an anonymous function
package main

import (
	DEATH "github.com/vrecan/death"
	SYS "syscall"
	"io"
)

func main() {
	death := DEATH.NewDeath(SYS.SIGINT, SYS.SIGTERM) //pass the signals you want to end your application
	//when you want to block for shutdown signals
	death.WaitForDeathWithFunc(func(){ 
		//do whatever you want on death
	}) 
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetPkgPath

func GetPkgPath(c io.Closer) (name string, pkgPath string)

GetPkgPath for an io closer.

Types

type Death

type Death struct {
	// contains filtered or unexported fields
}

Death manages the death of your application.

func NewDeath

func NewDeath(signals ...os.Signal) (death *Death)

NewDeath Create Death with the signals you want to die from.

func (*Death) FallOnSword

func (d *Death) FallOnSword()

FallOnSword manually initiates the death process.

func (*Death) SetLogger

func (d *Death) SetLogger(l Logger)

setLogger Override the default logger (seelog)

func (*Death) SetTimeout

func (d *Death) SetTimeout(t time.Duration)

Override the time death is willing to wait for a objects to be closed.

func (*Death) WaitForDeath

func (d *Death) WaitForDeath(closable ...io.Closer)

WaitForDeath wait for signal and then kill all items that need to die.

func (*Death) WaitForDeathWithFunc

func (d *Death) WaitForDeathWithFunc(f func())

WaitForDeathWithFunc allows you to have a single function get called when it's time to kill your application.

type Logger

type Logger interface {
	Error(v ...interface{}) error
	Debug(v ...interface{})
	Info(v ...interface{})
	Warn(v ...interface{}) error
}

Logger interface to log.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL