tasks

Documentation

Index

• type Manager
  • func NewManager() *Manager
  • func (m *Manager) PsiNodeName() string
  • func (m *Manager) SpawnTask(ctx context.Context, taskFn TaskFunc) Task
• type Task
• type TaskFunc
  • func (f TaskFunc) Run(progress TaskProgress) error
• type TaskHandle
• type TaskProgress

Types

type Manager

type Manager struct {
	psi.NodeBase
	// contains filtered or unexported fields
}

func NewManager

func NewManager() *Manager

func (*Manager) PsiNodeName

func (m *Manager) PsiNodeName() string

func (*Manager) SpawnTask

func (m *Manager) SpawnTask(ctx context.Context, taskFn TaskFunc) Task

type Task

type Task interface {
	psi.Node
	Name() string
	Description() string
	Progress() float64

	IsCompleted() bool
	Error() error

	Done() <-chan struct{}
}

type TaskFunc

type TaskFunc func(progress TaskProgress) error

func (TaskFunc) Run

func (f TaskFunc) Run(progress TaskProgress) error

type TaskHandle

type TaskHandle interface {
	Context() context.Context

	Cancel()
	Wait()
	Err() error
}

type TaskProgress

type TaskProgress interface {
	Context() context.Context
	Update(current, total int)
}