lock

Documentation

Overview

Package lock provides distributed locking

Index

• Variables
• type AcquireOption
  • func TTL(t time.Duration) AcquireOption
  • func Wait(t time.Duration) AcquireOption
• type AcquireOptions
• type Lock
• type Option
  • func Nodes(a ...string) Option
  • func Prefix(p string) Option
• type Options

Variables

var (
	ErrLockTimeout = errors.New("lock timeout")
)

Types

type AcquireOption

type AcquireOption func(o *AcquireOptions)

func TTL

func TTL(t time.Duration) AcquireOption

TTL sets the lock ttl

func Wait

func Wait(t time.Duration) AcquireOption

Wait sets the wait time

type AcquireOptions

type AcquireOptions struct {
	TTL  time.Duration
	Wait time.Duration
}

type Lock

type Lock interface {
	// Acquire a lock with given id
	Acquire(id string, opts ...AcquireOption) error
	// Release the lock with given id
	Release(id string) error
}

Lock is a distributed locking interface

type Option

type Option func(o *Options)

func Nodes

func Nodes(a ...string) Option

Nodes sets the addresses the underlying lock implementation

func Prefix

func Prefix(p string) Option

Prefix sets a prefix to any lock ids used

type Options

type Options struct {
	Nodes  []string
	Prefix string
}