orchestrator

Documentation

Index

• Constants
• func IsComplete(cs []object.Object) bool
• type Graph
• type Orchestrator
  • func New(store graph.Store, exchange exchange.Exchange, discovery discovery.Discoverer, ...) (Orchestrator, error)
  • func NewWithContext(ctx context.Context, store graph.Store, exchange exchange.Exchange, ...) (Orchestrator, error)
• type PubSub
  • func NewPubSub() PubSub
• type Publisher
• type Queue
  • func NewQueue(ctx context.Context, workers int) Queue
• type Subscriber
• 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 {
	Subscriber
	Sync(
		ctx context.Context,
		selector []string,
		addresses []string,
	) (
		*Graph,
		error,
	)
	Put(...object.Object) error
	Get(
		ctx context.Context,
		rootHash string,
	) (
		*Graph,
		error,
	)
}

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

func New

func New(
	store graph.Store,
	exchange exchange.Exchange,
	discovery discovery.Discoverer,
	localInfo *peer.LocalPeer,

) (
	Orchestrator,
	error,
)

New constructs a new orchestrator given an object store and exchange

func NewWithContext

func NewWithContext(
	ctx context.Context,
	store graph.Store,
	exchange exchange.Exchange,
	discovery discovery.Discoverer,
	localInfo *peer.LocalPeer,

) (
	Orchestrator,
	error,
)

NewWithContext constructs a new orchestrator given an object store and exchange

type PubSub

type PubSub interface {
	Publisher
	Subscriber
}

PubSub -

func NewPubSub

func NewPubSub() PubSub

NewPubSub constructs and returns a new PubSub

type Publisher

type Publisher interface {
	Publish(string)
}

Publisher deals with the publishing part of our PubSub

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 Subscriber

type Subscriber interface {
	Subscribe(chan string, ...filter)
	Unsubscribe(chan string)
}

Subscriber deals with the subscribing part of our PubSub

type WorkFunc

type WorkFunc func() error

WorkFunc defines work that must be completed