sync

Documentation

Overview

Package sync is an interface for distributed synchronization

Index

• Variables
• type ElectWatcher
• type Leader
• type LeaderOption
  • func LeaderId(id string) LeaderOption
  • func LeaderNS(ns string) LeaderOption
  • func LeaderTTL(t int64) LeaderOption
• type LeaderOptions
• type ListMembersOption
  • func MemberNS(ns string) ListMembersOption
• type ListMembersOptions
• type LockOption
  • func LockTTL(t time.Duration) LockOption
  • func LockWait(t time.Duration) LockOption
• type LockOptions
• type Member
• type ObserveResult
• type Option
  • func Nodes(a ...string) Option
  • func Prefix(p string) Option
• type Options
• type Role
• type Sync
• type WatchElectOption
  • func WatchId(id string) WatchElectOption
  • func WatchNS(ns string) WatchElectOption
• type WatchElectOptions

Variables

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

Types

type ElectWatcher

type ElectWatcher interface {
	// Next is a blocking call
	Next() (*Member, error)
	Close()
}

ElectWatcher watch election event

type Leader

type Leader interface {
	// Id leader node
	Id() string
	// Resign resigns leadership
	Resign() error
	// Observe watch leadership event
	Observe() chan ObserveResult
	// Primary get the info of primary role
	Primary() (*Member, error)
	// Status returns when leadership is lost
	Status() chan bool
}

Leader provides leadership election

type LeaderOption

type LeaderOption func(o *LeaderOptions)

func LeaderId

func LeaderId(id string) LeaderOption

LeaderId sets the leader id

func LeaderNS

func LeaderNS(ns string) LeaderOption

LeaderNS sets the leader namespace

func LeaderTTL

func LeaderTTL(t int64) LeaderOption

LeaderTTL sets the leader ttl

type LeaderOptions

type LeaderOptions struct {
	TTL       int64
	Namespace string
	Id        string
}

type ListMembersOption

type ListMembersOption func(o *ListMembersOptions)

func MemberNS

func MemberNS(ns string) ListMembersOption

MemberNS sets the list member namespace

type ListMembersOptions

type ListMembersOptions struct {
	Namespace string
}

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 Member

type Member struct {
	Leader    string `json:"leader"`
	Id        string `json:"id"`
	Namespace string `json:"namespace"`
	Role      Role   `json:"role"`
}

type ObserveResult

type ObserveResult struct {
	Namespace string `json:"namespace"`
	Id        string `json:"id"`
}

type Option

type Option func(o *Options)

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

type Options

type Options struct {
	Nodes  []string
	Prefix string
}

type Role

type Role string

const (
	Primary Role = "primary"
	Follow  Role = "follow"
)

type Sync

type Sync interface {
	// Init Initialise options
	Init(...Option) error
	// Options Return the options
	Options() Options
	// Leader Elect a leader
	Leader(ctx context.Context, name string, opts ...LeaderOption) (Leader, error)
	// ListMembers get all election member
	ListMembers(ctx context.Context, opts ...ListMembersOption) ([]*Member, error)
	// WatchElect watch leader event
	WatchElect(ctx context.Context, opts ...WatchElectOption) (ElectWatcher, error)
	// Lock acquires a lock
	Lock(ctx context.Context, id string, opts ...LockOption) error
	// Unlock releases a lock
	Unlock(ctx context.Context, id string) error
	// String Sync implementation
	String() string
}

Sync is an interface for distributed synchronization

type WatchElectOption

type WatchElectOption func(o *WatchElectOptions)

func WatchId

func WatchId(id string) WatchElectOption

WatchId sets the watch elector id

func WatchNS

func WatchNS(ns string) WatchElectOption

WatchNS sets the watch elector namespace

type WatchElectOptions

type WatchElectOptions struct {
	Namespace string
	Id        string
}