redis

Documentation

Index

• type Locker
  • func NewLocker(redis redis.UniversalClient, opts ...Option) *Locker
  • func (l *Locker) ForceRelease(ctx context.Context) error
  • func (l *Locker) Get(ctx context.Context) (locker.Owner, error)
  • func (l *Locker) LockedOwner(ctx context.Context) (locker.Owner, error)
  • func (l *Locker) Release(ctx context.Context, owner locker.Owner) error
  • func (l *Locker) Try(ctx context.Context, fn func()) error
  • func (l *Locker) Until(ctx context.Context, timeout time.Duration, fn func()) error
• type Option
  • func WithName(name string) Option
  • func WithSleep(sleep time.Duration) Option
  • func WithTTL(ttl time.Duration) Option

Types

type Locker

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

func NewLocker

func NewLocker(redis redis.UniversalClient, opts ...Option) *Locker

func (*Locker) ForceRelease

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

func (*Locker) Get

func (l *Locker) Get(ctx context.Context) (locker.Owner, error)

func (*Locker) LockedOwner

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

func (*Locker) Release

func (l *Locker) Release(ctx context.Context, owner locker.Owner) error

func (*Locker) Try

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

func (*Locker) Until

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

type Option

type Option func(*Locker)

func WithName

func WithName(name string) Option

func WithSleep

func WithSleep(sleep time.Duration) Option

func WithTTL

func WithTTL(ttl time.Duration) Option