jobs

README

Rumors jobs plugin

Installation

go get github.com/rumorsflow/jobs

Documentation

Index

• Constants
• type Config
  • func (cfg *Config) BuildAsynqConfig() *asynq.Config
  • func (cfg *Config) InitDefault()
• type Middleware
• type Plugin
  • func (p *Plugin) AddHandler(name endure.Named, handler asynq.Handler)
  • func (p *Plugin) AddMiddleware(name endure.Named, middleware Middleware)
  • func (p *Plugin) Collects() []any
  • func (p *Plugin) Init(cfg config.Configurer, log *zap.Logger, client redis.UniversalClient) error
  • func (p *Plugin) Name() string
  • func (p *Plugin) Serve() chan error
  • func (p *Plugin) Stop() error

Constants

const (
	DefaultQueue   = "default"
	AggregateQueue = "aggregate"
)

const PluginName = "jobs"

Types

type Config

type Config struct {
	// List of the middleware names (order will be preserved)
	Middleware               []string       `mapstructure:"middleware"`
	Concurrency              int            `mapstructure:"concurrency"`
	Queues                   map[string]int `mapstructure:"queues"`
	StrictPriority           bool           `mapstructure:"strict_priority"`
	HealthCheckInterval      time.Duration  `mapstructure:"health_check_interval"`
	DelayedTaskCheckInterval time.Duration  `mapstructure:"delayed_task_check_interval"`
	GroupGracePeriod         time.Duration  `mapstructure:"group_grace_period"`
	GroupMaxDelay            time.Duration  `mapstructure:"group_max_delay"`
	GroupMaxSize             int            `mapstructure:"group_max_size"`
}

func (*Config) BuildAsynqConfig

func (cfg *Config) BuildAsynqConfig() *asynq.Config

func (*Config) InitDefault

func (cfg *Config) InitDefault()

type Middleware

type Middleware interface {
	JobMiddleware(handler asynq.Handler) asynq.Handler
}

type Plugin

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

func (*Plugin) AddHandler

func (p *Plugin) AddHandler(name endure.Named, handler asynq.Handler)

func (*Plugin) AddMiddleware

func (p *Plugin) AddMiddleware(name endure.Named, middleware Middleware)

func (*Plugin) Collects

func (p *Plugin) Collects() []any

func (*Plugin) Init

func (p *Plugin) Init(cfg config.Configurer, log *zap.Logger, client redis.UniversalClient) error

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns user-friendly plugin name

func (*Plugin) Serve

func (p *Plugin) Serve() chan error

func (*Plugin) Stop

func (p *Plugin) Stop() error