scheduler

package
v0.0.0-...-956ff96 Latest Latest
Warning

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

Go to latest
Published: Sep 9, 2019 License: MIT Imports: 3 Imported by: 0

README

scheduler

GoDoc

package to run periodical jobs in background

Documentation

https://godoc.org/github.com/danielkraic/idmapper/scheduler

Example

type FirstJob struct {
}

func (firstJob FirstJob) Run() {
	fmt.Printf("FirstJob called\n")
}

func SecondJobFunc() {
	fmt.Printf("SecondJob called\n")
}

func Example() {
	scheduler := scheduler.Scheduler{}
	//scheduler.Add(&FirstJob{}, 100*time.Millisecond)
	err := scheduler.AddFunc(SecondJobFunc, 300*time.Millisecond)
	if err != nil {
		panic(err)
	}

	go scheduler.Start()

	time.Sleep(time.Second)
	scheduler.Stop()

	// Output:
	// SecondJob called
	// SecondJob called
	// SecondJob called
}

Documentation

Overview

Example
package main

import (
	"fmt"
	"time"

	"github.com/danielkraic/idmapper/scheduler"
)

type FirstJob struct {
}

func (firstJob FirstJob) Run() {
	fmt.Printf("FirstJob called\n")
}

func SecondJobFunc() {
	fmt.Printf("SecondJob called\n")
}

func main() {
	scheduler := scheduler.Scheduler{}
	//scheduler.Add(&FirstJob{}, 100*time.Millisecond)
	err := scheduler.AddFunc(SecondJobFunc, 300*time.Millisecond)
	if err != nil {
		panic(err)
	}

	go scheduler.Start()

	time.Sleep(time.Second)
	scheduler.Stop()

}
Output:

SecondJob called
SecondJob called
SecondJob called

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Job

type Job interface {
	Run()
}

Job interface with Run method

type JobFunc

type JobFunc func()

JobFunc is adapter to allow use ordinary function as Job

func (JobFunc) Run

func (jobFunc JobFunc) Run()

Run runs job

type Scheduler

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

Scheduler to run periodic jobs

func (*Scheduler) Add

func (scheduler *Scheduler) Add(job Job, duration time.Duration) error

Add adds job to scheduler

func (*Scheduler) AddFunc

func (scheduler *Scheduler) AddFunc(fn func(), duration time.Duration) error

AddFunc adds function to scheduler

func (*Scheduler) IsRunning

func (scheduler *Scheduler) IsRunning() bool

IsRunning return true it scheduler is already running

func (*Scheduler) Start

func (scheduler *Scheduler) Start()

Start starts scheduler by running all its jobs repeatedly

func (*Scheduler) Stop

func (scheduler *Scheduler) Stop()

Stop stops scheduler

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL