redis

Documentation

Index

• type Locker
  • func NewLocker(redis redis.UniversalClient, name string, timeout time.Duration, ...) *Locker
  • func (l *Locker) ForceRelease(ctx context.Context) error
  • func (l *Locker) LockedOwner(ctx context.Context) (string, error)
  • func (l *Locker) Owner() string
  • func (l *Locker) Release(ctx context.Context) (bool, error)
  • func (l *Locker) Try(ctx context.Context, fn func() error) error
  • func (l *Locker) Until(ctx context.Context, timeout time.Duration, fn func() error) error
• type Option
  • func WithOwner(owner string) Option
  • func WithSeconds(timeout time.Duration) Option
  • func WithSleep(sleep time.Duration) Option
  • func WithTimeout(timeout time.Duration) Option

Types

type Locker

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

func NewLocker

func NewLocker(redis redis.UniversalClient, name string, timeout time.Duration, opts ...Option) *Locker

func (*Locker) ForceRelease

func (l *Locker) ForceRelease(ctx context.Context) error

func (*Locker) LockedOwner

func (l *Locker) LockedOwner(ctx context.Context) (string, error)

func (*Locker) Owner

func (l *Locker) Owner() string

func (*Locker) Release

func (l *Locker) Release(ctx context.Context) (bool, error)

func (*Locker) Try

func (l *Locker) Try(ctx context.Context, fn func() error) error

func (*Locker) Until

func (l *Locker) Until(ctx context.Context, timeout time.Duration, fn func() error) error

type Option

type Option func(*Locker)

func WithOwner

func WithOwner(owner string) Option

func WithSeconds

func WithSeconds(timeout time.Duration) Option

Deprecated: Use WithTimeout instead.

func WithSleep

func WithSleep(sleep time.Duration) Option

func WithTimeout

func WithTimeout(timeout time.Duration) Option