job

README

go job

Usage

Install

go get github.com/eiixy/go-job

Example

./example

package main

import (
	"context"
	"errors"
	syslog "log"
	"os"
	"time"

	"github.com/go-kratos/kratos/v2/log"
	"golang.org/x/time/rate"

	"github.com/eiixy/go-job"
	"github.com/eiixy/go-job/report"
)

func main() {
	j := job.NewJob(
		log.DefaultLogger,
		job.NewWorker("test", example),
		job.NewWorker(
			"test-with-limiter",
			example,
			job.WithLimiter(rate.NewLimiter(rate.Every(time.Second), 10)),
		),
		job.NewWorker(
			"test-with-report-error",
			example,
			job.WithReport(report.NewQYWeiXinReport(os.Getenv("QY_WECHAT_TOKEN"))),
		),
	)
	err := j.Start(context.Background())
	if err != nil {
		panic(err)
	}
}

func example(ctx context.Context) error {
	syslog.Println("do something...")
	if time.Now().Second()%10 == 1 {
		// test report error
		return errors.New("test err")
	}
	return nil
}

Documentation

Index

• type Handler
• type Job
  • func NewJob(logger log.Logger, works ...*Worker) *Job
  • func NewJobWithReport(logger log.Logger, report ReportError, works ...*Worker) *Job
  • func (j Job) Start(ctx context.Context) error
• type ReportError
• type Worker
  • func NewWorker(name string, job Handler, opts ...WorkerOption) *Worker
• type WorkerOption
  • func WithLimiter(limiter *rate.Limiter) WorkerOption
  • func WithLimiterDuration(duration time.Duration) WorkerOption
  • func WithReport(report ReportError) WorkerOption
  • func WithSleep(duration time.Duration) WorkerOption

Types

type Handler

type Handler func(ctx context.Context) error

type Job

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

func NewJob

func NewJob(logger log.Logger, works ...*Worker) *Job

func NewJobWithReport

func NewJobWithReport(logger log.Logger, report ReportError, works ...*Worker) *Job

func (Job) Start

func (j Job) Start(ctx context.Context) error

type ReportError

type ReportError interface {
	Report(ctx context.Context, worker, content string) error
}

type Worker

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

func NewWorker

func NewWorker(name string, job Handler, opts ...WorkerOption) *Worker

type WorkerOption

type WorkerOption func(worker *Worker)

func WithLimiter

func WithLimiter(limiter *rate.Limiter) WorkerOption

func WithLimiterDuration

func WithLimiterDuration(duration time.Duration) WorkerOption

func WithReport

func WithReport(report ReportError) WorkerOption

func WithSleep

func WithSleep(duration time.Duration) WorkerOption