simplecron

README

simple-cron

Library to run func by cron. Also to limit func runtime. Written in Golang

usage example

var myfunc = func() {
	// func example
	time.Sleep(time.Second * 10)
}

isTimeIsUP := simplecron.NewRuntimeLimitHandler(
	time.Second * 2,
	myfunc,
).Run()
if isTimeIsUP {
	// handle timeout
}

---

🌐 Telegram канал

Documentation

Index

• type CronCallback
• type CronObject
  • func NewCronHandler(callback CronCallback, timerTime time.Duration) *CronObject
  • func (c *CronObject) IsActive() bool
  • func (c *CronObject) IsPaused() bool
  • func (c *CronObject) Pause()
  • func (c *CronObject) Resume()
  • func (c *CronObject) Run(immediately ...bool)
  • func (c *CronObject) Stop()
• type RunTimeLimitHandler
  • func NewRuntimeLimitHandler(timeout time.Duration, runFunc func()) *RunTimeLimitHandler
  • func (r *RunTimeLimitHandler) Run() bool

Types

type CronCallback

type CronCallback func()

CronCallback - cron callback /ᐠ｡‸｡ᐟ\

type CronObject

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

CronObject - cron object /ᐠ｡‸｡ᐟ\

func NewCronHandler

func NewCronHandler(callback CronCallback, timerTime time.Duration) *CronObject

NewCronHandler - create new cron

func (*CronObject) IsActive

func (c *CronObject) IsActive() bool

IsActive - check cron is not paused & is not stopped

func (*CronObject) IsPaused

func (c *CronObject) IsPaused() bool

IsPaused - check cron is paused status

func (*CronObject) Pause

func (c *CronObject) Pause()

Pause cron event exec

func (*CronObject) Resume

func (c *CronObject) Resume()

Resume cron event exec

func (*CronObject) Run

func (c *CronObject) Run(immediately ...bool)

Run cron

func (*CronObject) Stop

func (c *CronObject) Stop()

Stop cron

type RunTimeLimitHandler

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

RunTimeLimitHandler - func runtime limit handler

func NewRuntimeLimitHandler

func NewRuntimeLimitHandler(timeout time.Duration, runFunc func()) *RunTimeLimitHandler

NewRuntimeLimitHandler - create new func runtime limit handler

func (*RunTimeLimitHandler) Run

func (r *RunTimeLimitHandler) Run() bool

Run - run func & limit runtime. returns: bool: true if time is up