task

Documentation

Index

• type JobsAllocator
  • func NewConstantJobsAllocator(num int) *JobsAllocator
  • func (allocator *JobsAllocator) AvailableJobs(tracker *Task) int
  • func (allocator *JobsAllocator) Init()
  • func (allocator *JobsAllocator) MaxJobs() int
• type JobsScheduler
  • func NewJobsScheduler(num int) *JobsScheduler
  • func (s *JobsScheduler) GetJobsAllocator(taskName string) *JobsAllocator
  • func (s *JobsScheduler) Register(taskName string, priority int, privileged bool) bool
  • func (s *JobsScheduler) Unregister(taskName string)
• type Monitor
  • func NewTaskMonitor() *Monitor
  • func (tm *Monitor) Add(name string, done int)
  • func (tm *Monitor) Fail(name, err string)
  • func (tm *Monitor) Finish(name string)
  • func (tm *Monitor) Get(name string) int
  • func (tm *Monitor) GetTask(name string) *Task
  • func (tm *Monitor) List(workers ...string) []Task
  • func (tm *Monitor) Pending(name string)
  • func (tm *Monitor) Start(name string, total int) *Task
  • func (tm *Monitor) Suspend(name string, flag bool)
  • func (tm *Monitor) Update(name string, done int)
• type Status
• type SubTask
  • func (t *SubTask) Add(done int)
  • func (t *SubTask) Finish()
• type Task
  • func NewTask(name string, total int) *Task
  • func (t *Task) Add(done int)
  • func (t *Task) Fail(err string)
  • func (t *Task) Finish()
  • func (t *Task) SubTask(done int) *SubTask
  • func (t *Task) Suspend(flag bool)
  • func (t *Task) Update(done int)
• type Tasks
  • func (t Tasks) Len() int
  • func (t Tasks) Less(i, j int) bool
  • func (t Tasks) Swap(i, j int)

Types

type JobsAllocator

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

func NewConstantJobsAllocator

func NewConstantJobsAllocator(num int) *JobsAllocator

func (*JobsAllocator) AvailableJobs

func (allocator *JobsAllocator) AvailableJobs(tracker *Task) int

func (*JobsAllocator) Init

func (allocator *JobsAllocator) Init()

Init jobs allocation. This method is used to request allocation of jobs for the first time.

func (*JobsAllocator) MaxJobs

func (allocator *JobsAllocator) MaxJobs() int

type JobsScheduler

type JobsScheduler struct {
	*sync.Cond
	// contains filtered or unexported fields
}

JobsScheduler allocates jobs to multiple tasks.

func NewJobsScheduler

func NewJobsScheduler(num int) *JobsScheduler

NewJobsScheduler creates a JobsScheduler with num jobs.

func (*JobsScheduler) GetJobsAllocator

func (s *JobsScheduler) GetJobsAllocator(taskName string) *JobsAllocator

func (*JobsScheduler) Register

func (s *JobsScheduler) Register(taskName string, priority int, privileged bool) bool

Register a task in the JobsScheduler. Registered tasks will be ignored and return false.

func (*JobsScheduler) Unregister

func (s *JobsScheduler) Unregister(taskName string)

Unregister a task from the JobsScheduler.

type Monitor

type Monitor struct {
	TaskLock sync.Mutex
	Tasks    map[string]*Task
}

Monitor monitors the progress of all tasks.

func NewTaskMonitor

func NewTaskMonitor() *Monitor

NewTaskMonitor creates a Monitor and add pending tasks.

func (*Monitor) Add

func (tm *Monitor) Add(name string, done int)

Add the progress of a task.

func (*Monitor) Fail

func (tm *Monitor) Fail(name, err string)

func (*Monitor) Finish

func (tm *Monitor) Finish(name string)

Finish a task.

func (*Monitor) Get

func (tm *Monitor) Get(name string) int

Get the progress of a task.

func (*Monitor) GetTask

func (tm *Monitor) GetTask(name string) *Task

func (*Monitor) List

func (tm *Monitor) List(workers ...string) []Task

List all tasks and remove tasks from disconnected workers.

func (*Monitor) Pending

func (tm *Monitor) Pending(name string)

Pending a task.

func (*Monitor) Start

func (tm *Monitor) Start(name string, total int) *Task

Start a task.

func (*Monitor) Suspend

func (tm *Monitor) Suspend(name string, flag bool)

Suspend a task.

func (*Monitor) Update

func (tm *Monitor) Update(name string, done int)

Update the progress of a task.

type Status

type Status string

const (
	StatusPending   Status = "Pending"
	StatusComplete  Status = "Complete"
	StatusRunning   Status = "Running"
	StatusSuspended Status = "Suspended"
	StatusFailed    Status = "Failed"
)

type SubTask

type SubTask struct {
	Start  int
	End    int
	Parent *Task
}

func (*SubTask) Add

func (t *SubTask) Add(done int)

func (*SubTask) Finish

func (t *SubTask) Finish()

type Task

type Task struct {
	Name       string
	Status     Status
	Done       int
	Total      int
	StartTime  time.Time
	FinishTime time.Time
	Error      string
}

Task progress information.

func NewTask

func NewTask(name string, total int) *Task

func (*Task) Add

func (t *Task) Add(done int)

func (*Task) Fail

func (t *Task) Fail(err string)

func (*Task) Finish

func (t *Task) Finish()

func (*Task) SubTask

func (t *Task) SubTask(done int) *SubTask

func (*Task) Suspend

func (t *Task) Suspend(flag bool)

func (*Task) Update

func (t *Task) Update(done int)

type Tasks

type Tasks []Task

Tasks is used to sort []Task.

func (Tasks) Len

func (t Tasks) Len() int

Len is used to sort []Task.

func (Tasks) Less

func (t Tasks) Less(i, j int) bool

Less is used to sort []Task.

func (Tasks) Swap

func (t Tasks) Swap(i, j int)

Swap is used to sort []Task.