sync

Documentation

Overview

Package sync is an interface for distributed synchronization

Index

• Variables
• type Leader
• type LeaderOption
• type LeaderOptions
• type LockOption
  • func LockTTL(t time.Duration) LockOption
  • func LockWait(t time.Duration) LockOption
• type LockOptions
• type Option
  • func Logger(l logger.Logger) Option
  • func Meter(m meter.Meter) Option
  • func Nodes(a ...string) Option
  • func Prefix(p string) Option
  • func Tracer(t tracer.Tracer) Option
• type Options
  • func NewOptions(opts ...Option) Options
• type Sync

Variables

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

Types

type Leader

type Leader interface {
	// resign leadership
	Resign() error
	// status returns when leadership is lost
	Status() chan bool
}

Leader provides leadership election

type LeaderOption

type LeaderOption func(o *LeaderOptions)

type LeaderOptions

type LeaderOptions struct{}

type LockOption

type LockOption func(o *LockOptions)

func LockTTL

func LockTTL(t time.Duration) LockOption

LockTTL sets the lock ttl

func LockWait

func LockWait(t time.Duration) LockOption

LockWait sets the wait time

type LockOptions

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

type Option

type Option func(o *Options)

func Logger

func Logger(l logger.Logger) Option

Logger sets the logger

func Meter

func Meter(m meter.Meter) Option

Meter sets the logger

func Nodes

func Nodes(a ...string) Option

Nodes sets the addresses to use

func Prefix

func Prefix(p string) Option

Prefix sets a prefix to any lock ids used

func Tracer

func Tracer(t tracer.Tracer) Option

Tracer sets the tracer

type Options

type Options struct {
	Nodes  []string
	Prefix string
	Logger logger.Logger
	Tracer tracer.Tracer
	Meter  meter.Meter
}

func NewOptions

func NewOptions(opts ...Option) Options

type Sync

type Sync interface {
	// Initialise options
	Init(...Option) error
	// Return the options
	Options() Options
	// Elect a leader
	Leader(id string, opts ...LeaderOption) (Leader, error)
	// Lock acquires a lock
	Lock(id string, opts ...LockOption) error
	// Unlock releases a lock
	Unlock(id string) error
	// Sync implementation
	String() string
}

Sync is an interface for distributed synchronization