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

Index

• func New(opts ...ClientOpt) (*client, error)
• func NewTest(signingPrivateKey, signingPublicKey string, channels ...string) (*client, error)
• type ClientOpt
  • func WithAddress(address string) ClientOpt
  • func WithChannels(channels ...string) ClientOpt
  • func WithCluster(cluster bool) ClientOpt
  • func WithPrivateKey(key string) ClientOpt
  • func WithPublicKey(key string) 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.

func NewTest

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

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.

Types

type ClientOpt

type ClientOpt func(*client) error

ClientOpt represents a configuration option to initialize the queue client for Redis.

func WithAddress

func WithAddress(address string) ClientOpt

WithAddress sets the address in the queue client for Redis.

func WithChannels

func WithChannels(channels ...string) ClientOpt

WithChannels sets the channels in the queue client for Redis.

func WithCluster

func WithCluster(cluster bool) ClientOpt

WithCluster sets the clustering mode in the queue client for Redis.

func WithPrivateKey

func WithPrivateKey(key string) ClientOpt

WithPrivateKey sets the private key in the queue client for Redis.

func WithPublicKey

func WithPublicKey(key string) ClientOpt

WithPublicKey sets the public key in the queue client for Redis.

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOpt

WithTimeout sets the timeout in the queue client for Redis.