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(url string, channels ...string) (*client, error)
• func NewCluster(config string, channels ...string) (*client, error)
• func NewTest(channels ...string) (*client, error)

Functions

func New

func New(url string, channels ...string) (*client, error)

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

func NewCluster

func NewCluster(config string, channels ...string) (*client, error)

NewCluster returns a Queue implementation that integrates with a Redis queue cluster.

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.