worker

Documentation

Index

• type Option
  • func WithCtx(ctx context.Context) Option
  • func WithName(name string) Option
  • func WithStart(start func()) Option
  • func WithStop(stop func()) Option
  • func WithWg(wg *sync.WaitGroup) Option
• type OptionFunc
• type Options
• type Worker
  • func NewWorker(options ...Option) *Worker
  • func (w *Worker) Run()

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option 定义了一个接口，表示一个配置选项

func WithCtx

func WithCtx(ctx context.Context) Option

WithCtx 设置工作器的上下文选项

func WithName

func WithName(name string) Option

WithName 设置工作器的名称选项

func WithStart

func WithStart(start func()) Option

WithStart 设置工作器的启动函数选项

func WithStop

func WithStop(stop func()) Option

WithStop 设置工作器的停止函数选项

func WithWg

func WithWg(wg *sync.WaitGroup) Option

WithWg 设置工作器的等待组选项

type OptionFunc

type OptionFunc func(option *Options) error

OptionFunc 是一种为函数类型定义的新类型，它的参数需要传递指针

type Options

type Options struct {
	Name  string          `json:"name"` // 使用一致的命名风格
	Start func()          // 启动函数
	Stop  func()          // 停止函数
	Ctx   context.Context // 上下文
	Wg    *sync.WaitGroup // 等待组
}

Options 包含了工作器的所有配置选项

type Worker

type Worker struct {
	Options *Options `json:"options"` // 使用更加一致的名称，表示它可以包含多个选项
}

Worker 包含了工作器的配置选项

func NewWorker

func NewWorker(options ...Option) *Worker

NewWorker 创建一个新的 Worker 实例，接受一个或多个选项

func (*Worker) Run

func (w *Worker) Run()

Run 启动工作器，执行具体的工作