kkdaemon

README

goth-daemon

daemon process management with timer job support and stop all when kill signal raised.

HOWTO

// register daemon
kkdaemon.RegisterDaemon(daemons.DaemonSetupEnvironment)
kkdaemon.RegisterDaemon(daemons.DaemonSetupLogger)

// start daemon service
kkdaemon.Start()

// wait process killed
kkdaemon.ShutdownFuture().Await()

// or trigger `GracefullyShutdown` manually
go func(){
    <-time.After(time.Minute)
    kkdaemon.ShutdownGracefully()
}()

Define Daemon

DefaultDaemon

use default daemon to execute function when daemon service Start and Stop

type DefaultDaemonExample struct {
kkdaemon.DefaultTimerDaemon
}

func (d *DefaultDaemonExample) Registered() error {
// init func
return nil
}

func (d *DefaultDaemonExample) Start() {
// do when start
}

func (d *DefaultDaemonExample) Stop(sig os.Signal) {
// do when stop
}

TimerDaemon

timer daemon provide Loop func to be execute every Interval duration

type TimerDaemonExample struct {
kkdaemon.DefaultTimerDaemon
}

func (d *TimerDaemonExample) Registered() error {
// init func
return nil
}

func (d *TimerDaemonExample) Start() {
// do when start
}

func (d *TimerDaemonExample) Interval() time.Duration {
// run every minute
return time.Minute
}

func (d *TimerDaemonExample) Loop() error {
// do something
return nil
}

func (d *TimerDaemonExample) Stop(sig os.Signal) {
// do when stop
}

SchedulerDaemon

scheduler daemon use cron syntax to manage daemon Loop when be executed.

type SchedulerDaemonExample struct {
kkdaemon.DefaultSchedulerDaemon
}

func (d *SchedulerDaemonExample) Registered() error {
// init func
return nil
}

func (d *SchedulerDaemonExample) Start() {
// do when start
}

func (d *SchedulerDaemonExample) When() kkdaemon.CronSyntax {
// run every two minute
return "*/2 * * * *"
}

func (d *SchedulerDaemonExample) Loop() error {
// do something
return nil
}

func (d *SchedulerDaemonExample) Stop(sig os.Signal) {
// do when stop
}

Documentation

Index

• Constants
• Variables
• func IsShutdown() bool
• func RegisterDaemon(daemon Daemon) error
• func RegisterSimpleDaemon(name string, startFunc func(), stopFunc func(sig os.Signal)) error
• func ShutdownFuture() concurrent.Future
• func ShutdownGracefully()
• func Start() error
• func StartDaemon(name string) error
• func Stop(sig os.Signal) error
• func StopDaemon(name string, sig os.Signal) error
• func UnregisterDaemon(name string) error
• type CronSyntax
  • func (c CronSyntax) Next(from time.Time) time.Time
• type Daemon
• type DaemonEntity
  • func GetDaemon(name string) *DaemonEntity
• type DaemonService
  • func NewDaemonService() *DaemonService
  • func (s *DaemonService) GetDaemon(name string) *DaemonEntity
  • func (s *DaemonService) IsShutdown() bool
  • func (s *DaemonService) RegisterDaemon(daemon Daemon) error
  • func (s *DaemonService) ShutdownFuture() concurrent.Future
  • func (s *DaemonService) ShutdownGracefully()
  • func (s *DaemonService) Start() error
  • func (s *DaemonService) StartDaemon(entity *DaemonEntity) kkpanic.Caught
  • func (s *DaemonService) Stop(sig os.Signal) error
  • func (s *DaemonService) StopDaemon(entity *DaemonEntity, sig os.Signal) kkpanic.Caught
  • func (s *DaemonService) UnregisterDaemon(name string) error
• type DefaultDaemon
  • func (d *DefaultDaemon) Name() string
  • func (d *DefaultDaemon) Registered() error
  • func (d *DefaultDaemon) Start()
  • func (d *DefaultDaemon) State() int32
  • func (d *DefaultDaemon) Stop(sig os.Signal)
• type DefaultSchedulerDaemon
  • func (d *DefaultSchedulerDaemon) Loop() error
  • func (d *DefaultSchedulerDaemon) When() CronSyntax
• type DefaultTimerDaemon
  • func (d *DefaultTimerDaemon) Interval() time.Duration
  • func (d *DefaultTimerDaemon) Loop() error
• type Looper
• type PanicResult
• type SchedulerDaemon
• type TimerDaemon

Constants

const StateRun = int32(2)

const StateStart = int32(1)

const StateStop = int32(3)

const StateWait = int32(0)

Variables

var DefaultService = NewDaemonService()

Functions

func IsShutdown

func IsShutdown() bool

func RegisterDaemon

func RegisterDaemon(daemon Daemon) error

func RegisterSimpleDaemon

func RegisterSimpleDaemon(name string, startFunc func(), stopFunc func(sig os.Signal)) error

func ShutdownFuture

func ShutdownFuture() concurrent.Future

func ShutdownGracefully

func ShutdownGracefully()

func Start

func Start() error

func StartDaemon

func StartDaemon(name string) error

func Stop

func Stop(sig os.Signal) error

func StopDaemon

func StopDaemon(name string, sig os.Signal) error

func UnregisterDaemon

func UnregisterDaemon(name string) error

Types

type CronSyntax

type CronSyntax string

func (CronSyntax) Next

func (c CronSyntax) Next(from time.Time) time.Time

type Daemon

type Daemon interface {
	Registered() error
	State() int32
	Start()
	Stop(sig os.Signal)
	Name() string
	// contains filtered or unexported methods
}

type DaemonEntity

type DaemonEntity struct {
	Name   string
	Daemon Daemon
	Order  int
	Next   time.Time
}

func GetDaemon

func GetDaemon(name string) *DaemonEntity

type DaemonService

type DaemonService struct {
	// daemons map
	DaemonMap sync.Map
	// stop all daemon when get kill signal, default: `true`
	StopWhenKill bool
	// contains filtered or unexported fields
}

func NewDaemonService

func NewDaemonService() *DaemonService

func (*DaemonService) GetDaemon

func (s *DaemonService) GetDaemon(name string) *DaemonEntity

func (*DaemonService) IsShutdown

func (s *DaemonService) IsShutdown() bool

func (*DaemonService) RegisterDaemon

func (s *DaemonService) RegisterDaemon(daemon Daemon) error

func (*DaemonService) ShutdownFuture

func (s *DaemonService) ShutdownFuture() concurrent.Future

func (*DaemonService) ShutdownGracefully

func (s *DaemonService) ShutdownGracefully()

func (*DaemonService) Start

func (s *DaemonService) Start() error

func (*DaemonService) StartDaemon

func (s *DaemonService) StartDaemon(entity *DaemonEntity) kkpanic.Caught

func (*DaemonService) Stop

func (s *DaemonService) Stop(sig os.Signal) error

func (*DaemonService) StopDaemon

func (s *DaemonService) StopDaemon(entity *DaemonEntity, sig os.Signal) kkpanic.Caught

func (*DaemonService) UnregisterDaemon

func (s *DaemonService) UnregisterDaemon(name string) error

type DefaultDaemon

type DefaultDaemon struct {
	Params map[string]interface{}
	// contains filtered or unexported fields
}

func (*DefaultDaemon) Name

func (d *DefaultDaemon) Name() string

func (*DefaultDaemon) Registered

func (d *DefaultDaemon) Registered() error

func (*DefaultDaemon) Start

func (d *DefaultDaemon) Start()

func (*DefaultDaemon) State

func (d *DefaultDaemon) State() int32

func (*DefaultDaemon) Stop

func (d *DefaultDaemon) Stop(sig os.Signal)

type DefaultSchedulerDaemon

type DefaultSchedulerDaemon struct {
	DefaultDaemon
}

func (*DefaultSchedulerDaemon) Loop

func (d *DefaultSchedulerDaemon) Loop() error

func (*DefaultSchedulerDaemon) When

func (d *DefaultSchedulerDaemon) When() CronSyntax

type DefaultTimerDaemon

type DefaultTimerDaemon struct {
	DefaultDaemon
}

func (*DefaultTimerDaemon) Interval

func (d *DefaultTimerDaemon) Interval() time.Duration

func (*DefaultTimerDaemon) Loop

func (d *DefaultTimerDaemon) Loop() error

type Looper

type Looper interface {
	Loop() error
}

type PanicResult

type PanicResult struct {
	Daemon Daemon
	Caught kkpanic.Caught
}

type SchedulerDaemon

type SchedulerDaemon interface {
	Daemon
	Looper
	When() CronSyntax
}

type TimerDaemon

type TimerDaemon interface {
	Daemon
	Looper
	Interval() time.Duration
}