redisqueue

package module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 16, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(addr string, opts ...queue.Option) (*queue.Queue, error)

New creates a high-level Queue using the Redis backend. @group Constructors

Example: redis shorthand constructor

q, err := redisqueue.New(
	"127.0.0.1:6379",
	queue.WithWorkers(4), // optional; default: runtime.NumCPU() (min 1)
)
if err != nil {
	return
}
_ = q

func NewWithConfig

func NewWithConfig(cfg Config, opts ...queue.Option) (*queue.Queue, error)

NewWithConfig creates a high-level Queue using an explicit Redis driver config. @group Constructors

Example: redis config constructor

q, err := redisqueue.NewWithConfig(
	redisqueue.Config{
		DriverBaseConfig: queueconfig.DriverBaseConfig{
			DefaultQueue: "critical", // default if empty: "default"
			Observer:     nil,        // default: nil
		},
		Addr: "127.0.0.1:6379", // required
		Password: "",           // optional; default empty
		DB: 0,                  // optional; default 0
		ServerLogger: nil,      // optional; default backend logger
		ServerLogLevel: redisqueue.ServerLogLevelDefault, // optional
	},
	queue.WithWorkers(4), // optional; default: runtime.NumCPU() (min 1)
)
if err != nil {
	return
}
_ = q

Types

type Config

type Config struct {
	queueconfig.DriverBaseConfig
	Addr           string
	Password       string
	DB             int
	Queues         map[string]int
	ServerLogger   ServerLogger
	ServerLogLevel ServerLogLevel
}

Config configures the Redis driver module constructor.

type ServerLogLevel

type ServerLogLevel int

ServerLogLevel configures Redis worker server log verbosity.

const (
	// ServerLogLevelDefault leaves backend default log level unchanged.
	ServerLogLevelDefault ServerLogLevel = iota
	ServerLogLevelDebug
	ServerLogLevelInfo
	ServerLogLevelWarn
	ServerLogLevelError
	ServerLogLevelFatal
)

type ServerLogger

type ServerLogger = queue.Logger

ServerLogger is the Redis worker server logger contract. Deprecated: use queue.Logger via Config.DriverBaseConfig.Logger.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL