stream

Documentation

Index

• func NewStream(opts ...Option) (events.Stream, error)
• type Option
  • func Address(addr string) Option
  • func Password(password string) Option
  • func TLSConfig(tlsConfig *tls.Config) Option
  • func User(user string) Option
  • func WithRedisOptions(options *redis.UniversalOptions) Option
• type Options

Functions

func NewStream

func NewStream(opts ...Option) (events.Stream, error)

Types

type Option

type Option func(o *Options)

Option is a function which configures options.

func Address

func Address(addr string) Option

Address sets the Redis address option. Needs to be a full URL with scheme (redis://, rediss://, unix://). (eg. redis://user:password@localhost:6789/3?dial_timeout=3). Alternatively, the address can simply be the `host:port` format where User, Password, TLSConfig are defined with their respective options.

func Password

func Password(password string) Option

func TLSConfig

func TLSConfig(tlsConfig *tls.Config) Option

func User

func User(user string) Option

func WithRedisOptions

func WithRedisOptions(options *redis.UniversalOptions) Option

WithRedisOptions sets advanced options for redis.

type Options

type Options struct {
	Address   string
	User      string
	Password  string
	TLSConfig *tls.Config

	RedisOptions *redis.UniversalOptions
}

Options which are used to configure the redis stream.