worker

README

simpleworker-go

介绍

{以下是 Gitee 平台说明，您可以替换此简介 Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台（同时支持 SVN）。专为开发者提供稳定、高效、安全的云端软件开发协作平台 无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 https://gitee.com/enterprises}

软件架构

软件架构说明

安装教程

1. xxxx
2. xxxx
3. xxxx

使用说明

1. xxxx
2. xxxx
3. xxxx

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/

Documentation

Index

• Variables
• type OptionFunc
  • func WithContext(ctx context.Context, cancelFunc context.CancelFunc) OptionFunc
  • func WithOnError(onError func(p any) (err error)) OptionFunc
  • func WithOnStarted(onStarted func()) OptionFunc
  • func WithOnStop(onStopping func()) OptionFunc
  • func WithOnWorking(onWorking func(ctx context.Context) bool) OptionFunc
  • func WithStartWaiter(startWaiter *sync.WaitGroup) OptionFunc
  • func WithStopWaiter(stopWaiter *sync.WaitGroup) OptionFunc
• type Worker
  • func Create(startFunc func() error, wait bool, optionFuncs ...OptionFunc) (*Worker, error)
  • func (w *Worker) Stop(stopFunc func(), wait bool)
  • func (w *Worker) Working() bool

Variables

var (
	ErrAlreadyStarted = errors.New("already started")
	ErrNoOnWorking    = errors.New("no onWorking")
)

Types

type OptionFunc

type OptionFunc func(w *Worker)

func WithContext

func WithContext(ctx context.Context, cancelFunc context.CancelFunc) OptionFunc

func WithOnError

func WithOnError(onError func(p any) (err error)) OptionFunc

func WithOnStarted

func WithOnStarted(onStarted func()) OptionFunc

func WithOnStop

func WithOnStop(onStopping func()) OptionFunc

func WithOnWorking

func WithOnWorking(onWorking func(ctx context.Context) bool) OptionFunc

func WithStartWaiter

func WithStartWaiter(startWaiter *sync.WaitGroup) OptionFunc

func WithStopWaiter

func WithStopWaiter(stopWaiter *sync.WaitGroup) OptionFunc

type Worker

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

func Create

func Create(startFunc func() error, wait bool, optionFuncs ...OptionFunc) (*Worker, error)

func (*Worker) Stop

func (w *Worker) Stop(stopFunc func(), wait bool)

func (*Worker) Working

func (w *Worker) Working() bool