worker

package

v0.1.12 Latest Latest Go to latest Published: May 5, 2025 License: Apache-2.0 Imports: 4 Imported by: 1

Details

This section is empty.

This section is empty.

This section is empty.

type Option func(conf *asynq.Config)

Option is a function, which configures the Worker.

func WithErrorHandler(handler asynq.ErrorHandler) Option

WithErrorHandler is an Option, which configures the Worker to use the specified asynq.ErrorHandler.

func WithLogLevel(level asynq.LogLevel) Option

WithLogLevel is an Option, which configures the log level of the Worker.

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

Worker wraps an asynq.Server and asynq.ServeMux with additional convenience methods for task handlers.

func NewFromConfig(r asynq.RedisClientOpt, conf config.WorkerConfig, opts ...Option) *Worker

NewFromConfig creates a new Worker based on the provided config.WorkerConfig spec.

func (w *Worker) Handle(pattern string, handler asynq.Handler)

Handle registers a new handler with the Worker's multiplexer.

func (w *Worker) HandlersFromRegistry(reg *registry.Registry[string, asynq.Handler])

HandlersFromRegistry registers task handlers with the Worker multiplexer using the given registry.

func (w *Worker) Run() error

Run starts the task processing by calling asynq.Server.Start and blocks until an OS signal is received.

func (w *Worker) Shutdown()

Shutdown gracefully shuts down the server by calling asynq.Server.Shutdown.

func (w *Worker) UseMiddlewares(middlewares ...asynq.MiddlewareFunc)

UseMiddlewares configures the Worker multiplexer to use the specified asynq.MiddlewareFunc.