Documentation ¶
Overview ¶
Package redis provides the ability for Vela to integrate with a Redis server as a queue backend.
Usage:
import "github.com/go-vela/server/queue/redis"
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
New returns a Queue implementation that integrates with a Redis queue instance.
nolint: revive // ignore returning unexported client
func NewTest ¶
NewTest returns a Queue implementation that integrates with a local Redis instance.
It's possible to override this with env variables, which gets used as a part of integration testing with the different supported backends.
This function is intended for running tests only.
nolint: revive // ignore returning unexported client
Types ¶
type ClientOpt ¶ added in v0.11.0
type ClientOpt func(*client) error
ClientOpt represents a configuration option to initialize the queue client for Redis.
func WithAddress ¶ added in v0.11.0
WithAddress sets the address in the queue client for Redis.
func WithChannels ¶ added in v0.11.0
WithChannels sets the channels in the queue client for Redis.
func WithCluster ¶ added in v0.11.0
WithCluster sets the clustering mode in the queue client for Redis.
func WithTimeout ¶ added in v0.11.0
WithTimeout sets the timeout in the queue client for Redis.