curlew

README

Curlew

Curlew is a job pool based on a local machine.

Feature

• Automatically scale the number of workers up or down.
• Maximum job execution time.
• Don't ensure the job execution order.

Usage

package main

import (
	"context"
	"errors"
	"fmt"
	"github.com/xiaojiaoyu100/curlew"
)

func monitor(err error) {
	fmt.Println(err)
}

func main() {
	d, err := curlew.New(curlew.WithMonitor(monitor))
	if err != nil {
		fmt.Println(err)
		return
	}
	j := curlew.NewJob()
	j.Arg = 3
	j.Fn = func(ctx context.Context, arg interface{}) error {
		fmt.Println("I'm done")
		return nil
	}
	d.Submit(j)
	select {}
}

Documentation

Index

• type Dispatcher
  • func New(setters ...Setter) (*Dispatcher, error)
  • func (d *Dispatcher) EnableDebug()
  • func (d *Dispatcher) NewWorker() *Worker
  • func (d *Dispatcher) RunningWorkerNum() int
  • func (d *Dispatcher) Submit(j *Job)
• type Handler
• type Job
  • func NewJob() *Job
• type Monitor
• type Setter
  • func WithMaxWorkerNum(num int) Setter
  • func WithMonitor(monitor Monitor) Setter
• type Worker

Types

type Dispatcher

type Dispatcher struct {
	MaxWorkerNum         int           // maximum  worker num in the pool
	MaxJobRunningTimeout time.Duration // job execution timeout
	WorkerPool           chan *Worker  // worker pool
	// contains filtered or unexported fields
}

Dispatcher takes the responsibility of dispatching jobs to available workers.

func New

func New(setters ...Setter) (*Dispatcher, error)

New creates a dispatcher instance.

func (*Dispatcher) EnableDebug

func (d *Dispatcher) EnableDebug()

EnableDebug enables debug info.

func (*Dispatcher) NewWorker

func (d *Dispatcher) NewWorker() *Worker

NewWorker 生成一个工作协程

func (*Dispatcher) RunningWorkerNum

func (d *Dispatcher) RunningWorkerNum() int

RunningWorkerNum returns the current running worker num.

func (*Dispatcher) Submit

func (d *Dispatcher) Submit(j *Job)

Submit submits a job.

type Handler

type Handler func(ctx context.Context, arg interface{}) error

Handler provides the job function signature.

type Job

type Job struct {
	Fn  Handler
	Arg interface{}
}

Job defines a job.

func NewJob

func NewJob() *Job

NewJob creates a job instance.

type Monitor

type Monitor func(err error)

Monitor 监控

type Setter

type Setter func(d *Dispatcher) error

Setter configures a Dispatcher.

func WithMaxWorkerNum

func WithMaxWorkerNum(num int) Setter

WithMaxWorkerNum configures maximum number of workers in the pool.

func WithMonitor

func WithMonitor(monitor Monitor) Setter

WithMonitor configures a monitor.

type Worker

type Worker struct {
	Jobs chan *Job
	// contains filtered or unexported fields
}

Worker 工作协程