framework

type Candidate struct {
	// Node represents the candidate nodeTracker.
	Node api.NodeTracker
	// Only set after scoring.
	Score float32
}

type ChunkInfo struct {
	Name         string
	Size         int64
	Path         string
	Revision     string
	NodeSelector map[string]string
}

type DefaultFramework struct {
	// contains filtered or unexported fields
}

type Download interface {
	Framework
}

type FilterPlugin interface {
	Plugin
	// Filter helps to filter out unrelated nodes.
	// Once NodeInfo is nil, it's a download task, otherwise it's a sync task.
	Filter(context.Context, ChunkInfo, *NodeInfo, api.NodeTracker, *cache.Cache) Status
}

type Framework interface {
	// RegisterPlugins will register the plugins to run.
	RegisterPlugins([]RegisterFunc) error
	// RunFilterPlugins will filter out unsatisfied peers.
	// NodeInfo refers to the source node in syncing tasks, it must not be nil in syncing,
	// on the contrary, it must be nil in downloading tasks.
	RunFilterPlugins(context.Context, ChunkInfo, *NodeInfo, []api.NodeTracker, *cache.Cache) []Candidate
	// RunScorePlugins will calculate the scores of all the peers.
	// NodeInfo refers to the source node in syncing tasks, it must not be nil in syncing,
	// on the contrary, it must be nil in downloading tasks.
	RunScorePlugins(context.Context, ChunkInfo, *NodeInfo, []Candidate, *cache.Cache) []Candidate
}

type NodeInfo struct {
	Name string
}

type Plugin interface {
	Name() string
}

type PreFilterPlugin interface {
	Plugin
	// PreFilter helps to do some computing before calling Filter plugins.
	PreFilter(context.Context, ChunkInfo, *cache.Cache) Status
}

type RegisterFunc = func() (Plugin, error)

type Registry map[string]Plugin

type ScoreCandidate struct {
	// SourceNodeName represents the the source node name in syncing tasks.
	// It's empty once in downloading tasks.
	SourceNodeName string
	// CandidateNodeName represents the target node name.
	CandidateNodeName string
	// Score for candidate node.
	Score float32
}

type ScorePlugin interface {
	Plugin
	// Score gets the score of the nodeTracker, it should be ranged between
	// 0 and 100.
	// Once NodeInfo is nil, it's a download task, otherwise it's a sync task.
	Score(context.Context, ChunkInfo, *NodeInfo, api.NodeTracker, *cache.Cache) float32
}

type Status struct {
	Code StatusCode
}

type StatusCode string

type Sync interface {
	Framework
}