orchestrator

Documentation

Index

• Constants
• func IsComplete(cs []object.Object) bool
• type Graph
• type Orchestrator
  • func New(st *sqlobjectstore.Store, ex exchange.Exchange, ds resolver.Resolver, ...) (Orchestrator, error)
  • func NewWithContext(ctx context.Context, st *sqlobjectstore.Store, ex exchange.Exchange, ...) (Orchestrator, error)
• type Queue
  • func NewQueue(ctx context.Context, workers int) Queue
• type WorkFunc

Constants

const (
	// ErrIncompleteGraph is returned when a requested graph is incomplete
	ErrIncompleteGraph = errors.Error("incomplete graph")
)

Functions

func IsComplete

func IsComplete(cs []object.Object) bool

IsComplete checks if a graph is missing any nodes

Types

type Graph

type Graph struct {
	Objects []object.Object
}

type Orchestrator

type Orchestrator interface {
	Sync(
		ctx context.Context,
		stream object.Hash,
		recipient *peer.Peer,
	) (*Graph, error)
	Put(object.Object) error
	Get(
		ctx context.Context,
		root object.Hash,
	) (*Graph, error)
}

Orchestrator is responsible of keeping streams and their underlying graphs up to date

func New

func New(
	st *sqlobjectstore.Store,
	ex exchange.Exchange,
	ds resolver.Resolver,
	kc keychain.Keychain,
) (Orchestrator, error)

New constructs a new orchestrator given an object store and exchange

func NewWithContext

func NewWithContext(
	ctx context.Context,
	st *sqlobjectstore.Store,
	ex exchange.Exchange,
	ds resolver.Resolver,
	kc keychain.Keychain,
) (Orchestrator, error)

NewWithContext constructs a new orchestrator given an object store and exchange

type Queue

type Queue interface {
	Enqueue(key string, work WorkFunc) error
}

Queue -

func NewQueue

func NewQueue(ctx context.Context, workers int) Queue

NewQueue constructs a new queue

type WorkFunc

type WorkFunc func() error

WorkFunc defines work that must be completed