go-micro/sync/sync.go

// Package sync is a distributed synchronization framework
package sync

import (
	"github.com/micro/go-micro/v2/store"
	"github.com/micro/go-micro/v2/sync/leader"
	"github.com/micro/go-micro/v2/sync/lock"
	"github.com/micro/go-micro/v2/sync/task"
	"github.com/micro/go-micro/v2/sync/time"
)

// Map provides synchronized access to key-value storage.
// It uses the store interface and lock interface to
// provide a consistent storage mechanism.
type Map interface {
	// Read value with given key
	Read(key, val interface{}) error
	// Write value with given key
	Write(key, val interface{}) error
	// Delete value with given key
	Delete(key interface{}) error
	// Iterate over all key/vals. Value changes are saved
	Iterate(func(key, val interface{}) error) error
}

// Cron is a distributed scheduler using leader election
// and distributed task runners. It uses the leader and
// task interfaces.
type Cron interface {
	Schedule(task.Schedule, task.Command) error
}

type Options struct {
	Leader leader.Leader
	Lock   lock.Lock
	Store  store.Store
	Task   task.Task
	Time   time.Time
}

type Option func(o *Options)