redislock

README

redislock

install

go get github.com/go-co-op/gocron-redis-lock

usage

Here is an example usage that would be deployed in multiple instances

package main

import (
	"fmt"
	"time"

	"github.com/go-co-op/gocron"
	"github.com/redis/go-redis/v9"

	redislock "github.com/go-co-op/gocron-redis-lock"
)

func main() {
	redisOptions := &redis.Options{
		Addr: "localhost:6379",
	}
	redisClient := redis.NewClient(redisOptions)
	locker, err := redislock.NewRedisLocker(redisClient, redislock.WithTries(1))
	if err != nil {
		// handle the error
	}

	s := gocron.NewScheduler(time.UTC)
	s.WithDistributedLocker(locker)

	_, err = s.Every("1s").Name("unique_name").Do(func() {
		// task to do
		fmt.Println("call 1s")
	})
	if err != nil {
		// handle the error
	}

	s.StartBlocking()
}

The redis UniversalClient can also be used

package main

import (
	"fmt"
	"time"

	"github.com/go-co-op/gocron"
	"github.com/redis/go-redis/v9"

	redislock "github.com/go-co-op/gocron-redis-lock"
)

func main() {
	redisOptions := &redis.UniversalOptions{
		Addrs: []string{"localhost:6379"},
	}
	redisClient := redis.NewUniversalClient(redisOptions)
	locker, err := redislock.NewRedisLocker(redisClient, redislock.WithTries(1))
	if err != nil {
		// handle the error
	}

	s := gocron.NewScheduler(time.UTC)
	s.WithDistributedLocker(locker)

	_, err = s.Every("1s").Name("unique_name").Do(func() {
		// task to do
		fmt.Println("call 1s")
	})
	if err != nil {
		// handle the error
	}

	s.StartBlocking()
}

Documentation

Index

• Variables
• func NewRedisLocker(r redis.UniversalClient, options ...redsync.Option) (gocron.Locker, error)
• func NewRedisLockerAlways(r redis.UniversalClient, options ...redsync.Option) (gocron.Locker, error)
• func NewRedisLockerWithOptions(r redis.UniversalClient, options ...LockerOption) (gocron.Locker, error)
• type LockerOption
  • func WithAutoExtendDuration(duration time.Duration) LockerOption
  • func WithRedsyncOptions(options ...redsync.Option) LockerOption

Variables

var (
	WithExpiry         = redsync.WithExpiry
	WithDriftFactor    = redsync.WithDriftFactor
	WithGenValueFunc   = redsync.WithGenValueFunc
	WithRetryDelay     = redsync.WithRetryDelay
	WithRetryDelayFunc = redsync.WithRetryDelayFunc
	WithTimeoutFactor  = redsync.WithTimeoutFactor
	WithTries          = redsync.WithTries
	WithValue          = redsync.WithValue
)

alias options

Functions

func NewRedisLocker

func NewRedisLocker(r redis.UniversalClient, options ...redsync.Option) (gocron.Locker, error)

NewRedisLocker provides an implementation of the Locker interface using redis for storage.

func NewRedisLockerAlways

func NewRedisLockerAlways(r redis.UniversalClient, options ...redsync.Option) (gocron.Locker, error)

NewRedisLockerAlways provides an implementation of the Locker interface using redis for storage, even if the connection fails.

func NewRedisLockerWithOptions

func NewRedisLockerWithOptions(r redis.UniversalClient, options ...LockerOption) (gocron.Locker, error)

Types

type LockerOption

type LockerOption func(*redisLocker)

func WithAutoExtendDuration

func WithAutoExtendDuration(duration time.Duration) LockerOption

func WithRedsyncOptions

func WithRedsyncOptions(options ...redsync.Option) LockerOption

WithRedsyncOptions sets the redsync options.