redis

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/pkg-queue/queue/redis"

Index

• func New(opts ...ClientOpt) (*client, error)
• func NewTest(channels ...string) (*client, error)
• type ClientOpt
  • func WithAddress(address string) ClientOpt
  • func WithChannels(channels ...string) ClientOpt
  • func WithCluster(cluster bool) ClientOpt
  • func WithTimeout(timeout time.Duration) ClientOpt

Functions

func New

func New(opts ...ClientOpt) (*client, error)

New returns a Queue implementation that integrates with a Redis queue instance.

nolint: golint // ignore returning unexported client

func NewTest

func NewTest(channels ...string) (*client, error)

NewTest returns a Queue implementation that integrates with a local Redis instance.

It's possible to overide 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: golint // ignore returning unexported client

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the queue client.

func WithAddress

func WithAddress(address string) ClientOpt

WithAddress sets the Redis address in the queue client.

func WithChannels

func WithChannels(channels ...string) ClientOpt

WithChannels sets the Redis channels in the queue client.

func WithCluster

func WithCluster(cluster bool) ClientOpt

WithCluster sets the Redis clustering mode in the queue client.

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOpt

WithTimeout sets the Redis timeout in the queue client.