redis

Documentation

Index

• Variables
• func PullFor[T any](ctx context.Context, app App, key string, done <-chan struct{}, ...)
• func SubscribeFor[T any](ctx context.Context, app App, channel string, handler func(T, error)) func(context.Context) error
• type App
  • func New(config Config, prometheusRegisterer prometheus.Registerer, tracer trace.Tracer) App
  • func (a App) Delete(ctx context.Context, keys ...string) error
  • func (a App) Exclusive(ctx context.Context, name string, timeout time.Duration, ...) (acquired bool, err error)
  • func (a App) Load(ctx context.Context, key string) (string, error)
  • func (a App) Ping() error
  • func (a App) Publish(ctx context.Context, channel string, value any) error
  • func (a App) Pull(ctx context.Context, key string, done <-chan struct{}, ...)
  • func (a App) Push(ctx context.Context, key string, value any) error
  • func (a App) Store(ctx context.Context, key string, value any, duration time.Duration) error
  • func (a App) Subscribe(ctx context.Context, channel string) (<-chan *redis.Message, func(context.Context) error)
• type Config
  • func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) Config

Variables

var ErrNoSubscriber = errors.New("no subscriber for channel")

ErrNoSubscriber occurs when a published message is not received by any subscriber

Functions

func PullFor

func PullFor[T any](ctx context.Context, app App, key string, done <-chan struct{}, handler func(T, error))

PullFor pull with unmarshal of given type

func SubscribeFor

func SubscribeFor[T any](ctx context.Context, app App, channel string, handler func(T, error)) func(context.Context) error

SubscribeFor pubsub with unmarshal of given type

Types

type App

type App struct {
	// contains filtered or unexported fields
}

App of package

func New

func New(config Config, prometheusRegisterer prometheus.Registerer, tracer trace.Tracer) App

New creates new App from Config

func (App) Delete

func (a App) Delete(ctx context.Context, keys ...string) error

Delete given keys

func (App) Exclusive

func (a App) Exclusive(ctx context.Context, name string, timeout time.Duration, action func(context.Context) error) (acquired bool, err error)

Exclusive get an exclusive lock for given name during duration

func (App) Load

func (a App) Load(ctx context.Context, key string) (string, error)

Load given key

func (App) Ping

func (a App) Ping() error

Ping check redis availability

func (App) Publish

func (a App) Publish(ctx context.Context, channel string, value any) error

Publish a message to a given channel

func (App) Pull

func (a App) Pull(ctx context.Context, key string, done <-chan struct{}, handler func(string, error))

Pull tasks from a list

func (App) Push

func (a App) Push(ctx context.Context, key string, value any) error

Push a task to a list

func (App) Store

func (a App) Store(ctx context.Context, key string, value any, duration time.Duration) error

Store give key/val with duration

func (App) Subscribe

func (a App) Subscribe(ctx context.Context, channel string) (<-chan *redis.Message, func(context.Context) error)

Subscribe to a given channel

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config of package

func Flags

func Flags(fs *flag.FlagSet, prefix string, overrides ...flags.Override) Config

Flags adds flags for configuring package