redigo

Documentation

Index

• func NewRedisPoolFromURL(rawURL string, opts ...OptionFunc) (*redis.Pool, error)
• func WaitForAvailability(url string, d time.Duration, f WaitFunc) (bool, error)
• type DialURLFunc
• type OptionFunc
  • func WithDialURLFunc(df DialURLFunc) OptionFunc
  • func WithPasswords(passes ...string) OptionFunc
• type WaitFunc

Functions

func NewRedisPoolFromURL

func NewRedisPoolFromURL(rawURL string, opts ...OptionFunc) (*redis.Pool, error)

NewRedisPoolFromURL returns a new *redigo/redis.Pool configured for the supplied url. If the url includes a password in the standard form it is used to AUTH against the redis server

func WaitForAvailability

func WaitForAvailability(url string, d time.Duration, f WaitFunc) (bool, error)

WaitForAvailability of the redis server located at the provided url, timeout if the Duration passes before being able to connect

Types

type DialURLFunc

type DialURLFunc func(string, ...redis.DialOption) (redis.Conn, error)

DialURLFunc describes the type implemented by redis.DialURL, useful for changing the behavior of a redis Dialer.

type OptionFunc

type OptionFunc func(*redisDialer)

OptionFunc sets redisDialer options

func WithDialURLFunc

func WithDialURLFunc(df DialURLFunc) OptionFunc

WithDialURLFunc specifies an alternative DialURLFunc to use when dialing via URL.

func WithPasswords

func WithPasswords(passes ...string) OptionFunc

WithPasswords specifies additional passwords to try authenticating with when dialing

type WaitFunc

type WaitFunc func(time.Time) error

WaitFunc to be executed occasionally by something that is waiting. Should return an error to cancel the waiting Should also sleep some amount of time to throttle connection attempts