README
¶
runner
Interruptable goroutines.
Usage
task := runner.Go(func(shouldStop runner.S) error {
// do setup work
defer func(){
// do tear-down work
}()
for {
// do stuff
// periodically check to see if we should
// stop or not.
if shouldStop() {
break
}
}
return nil // no errors
})
At any time, from any place, you can stop the code from executing:
task.Stop()
select {
case <-task.StopChan():
// task successfully stopped
case <-time.After(1 * time.Second):
// task didn't stop in time
}
// execution continues once the code has stopped or has
// timed out.
if task.Err() != nil {
log.Fatalln("task failed:", task.Err())
}
- To see if the task is running, you can call
task.Running() - To see if the task has errored, you can check
task.Err()
Documentation
¶
Overview ¶
Package runner provides interruptable goroutines.
task := runner.Go(func(shouldStop runner.S) error {
// do setup
// defer func(){
// // do teardown
// }
for {
// do some work
if shouldStop() {
break
}
}
return nil // any errors?
})
// meanwhile...
// stop the task
task.Stop()
// wait for it to stop (or time out)
select {
case <-task.StopChan():
// stopped
case <-time.After(1 * time.Second):
log.Fatalln("task didn't stop quickly enough")
}
// check errors
if task.Err() != nil {
log.Fatalln("task failed:", task.Err())
}
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type S ¶
type S func() bool
S is a function that will return true if the goroutine should stop executing.
type Task ¶
type Task struct {
ID string
// contains filtered or unexported fields
}
Task represents an interruptable goroutine.
func Go ¶
Go executes the function in a goroutine and returns a Task capable of stopping the execution.
Source Files
Click to show internal directories.
Click to hide internal directories.