sync

Documentation

Overview

Package sync is an interface for distributed synchronization

Index

• Variables
• type Leader
• type 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 Option
  • func Nodes(a ...string) Option
  • func Prefix(p string) Option
• type Options
• type Role
• type Sync

Variables

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

Types

type Leader

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

Leader provides leadership election

type LeaderOption

type LeaderOption func(o *LeaderOptions)

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
}

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 {
	Id   string `json:"id"`
	Role Role   `json:"role"`
}

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(id string, opts ...LeaderOption) (Leader, error)
	// ListMembers get all election member
	ListMembers(opts ...ListMembersOption) ([]*Member, error)
	// Lock acquires a lock
	Lock(id string, opts ...LockOption) error
	// Unlock releases a lock
	Unlock(id string) error
	// String Sync implementation
	String() string
}

Sync is an interface for distributed synchronization