bgroutine

README

bgRoutine (Background Routine)

This package will take care of the functionality involved and concerning background routines. This can be used for (but it not limited to) creating job systems. However, it does not try to replace an existing full blown Job system.

The routine manager is supposed to let you Start, Pause, Resume and Stop a routine. You can schedule a routine either with a Cron Job expression or as a function that runs every x intervals (e.g. every 20 seconds). You can configure a routine to have a single instance or multiple instances.

Documentation

Overview

Package bgroutine is for managing the background routines

Index

• Constants
• type Manager
  • func NewManager() Manager
  • func (m *Manager) AddRoutine(name string, cronExpression string, runnerFunc func() appError.Typ) appError.Typ
  • func (m *Manager) ShutdownAllRoutines()
• type Typ
  • func (r *Typ) AddMonitorFunc(f func(typ appError.Typ))
  • func (r *Typ) CurrentMode() string
  • func (r *Typ) GetCurrentState() string
  • func (r *Typ) IsPaused() bool
  • func (r *Typ) IsRunning() bool
  • func (r *Typ) IsTerminated() bool
  • func (r *Typ) Pause()
  • func (r *Typ) Resume()
  • func (r *Typ) Start(launchRightNow bool) appError.Typ
  • func (r *Typ) Stop()

Constants

const (
	StateUninitialized = "uninitialized"
	StateInitialized   = "initialized"
	StatePaused        = "paused"
	StateRunning       = "running"
	StateTerminated    = "terminated"
)

const (
	CronMode   = "cronMode"   // When we are working in the cron mode
	TickerMode = "tickerMode" // When we are working in the ticker mode
)

Types

type Manager

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

func NewManager

func NewManager() Manager

func (*Manager) AddRoutine

func (m *Manager) AddRoutine(name string, cronExpression string, runnerFunc func() appError.Typ) appError.Typ

func (*Manager) ShutdownAllRoutines

func (m *Manager) ShutdownAllRoutines()

type Typ

type Typ struct {
	Name string // Name of the routine
	// contains filtered or unexported fields
}

func (*Typ) AddMonitorFunc

func (r *Typ) AddMonitorFunc(f func(typ appError.Typ))

func (*Typ) CurrentMode

func (r *Typ) CurrentMode() string

func (*Typ) GetCurrentState

func (r *Typ) GetCurrentState() string

func (*Typ) IsPaused

func (r *Typ) IsPaused() bool

func (*Typ) IsRunning

func (r *Typ) IsRunning() bool

func (*Typ) IsTerminated

func (r *Typ) IsTerminated() bool

func (*Typ) Pause

func (r *Typ) Pause()

func (*Typ) Resume

func (r *Typ) Resume()

func (*Typ) Start

func (r *Typ) Start(launchRightNow bool) appError.Typ

func (*Typ) Stop

func (r *Typ) Stop()