task

README

Task

task is a simple Go library to execute tasks after each other. When one of the tasks fails the queue will be walked backwards and each task gets the opportunity to run rollback actions of the actions performed beforehand.

Installation

To install, simply execute:

go get github.com/denderello/task

Example

You can find a simple example in examples/bool_tasks.go which you can run like this:

go run examples/bool_tasks.go

Documentation

Index

• type Queue
  • func NewQueue(tasks []Task) *Queue
  • func (q *Queue) Start() error
• type QueueExecutionError
  • func (e *QueueExecutionError) Error() string
• type Task
• type TaskRecorder
  • func NewTaskRecorder(taskName string, runSuccessful, rollbackSuccessful bool) *TaskRecorder
  • func (t *TaskRecorder) Name() string
  • func (t *TaskRecorder) Rollback() error
  • func (t *TaskRecorder) Run() error

Types

type Queue

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

func NewQueue

func NewQueue(tasks []Task) *Queue

func (*Queue) Start

func (q *Queue) Start() error

type QueueExecutionError

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

func (*QueueExecutionError) Error

func (e *QueueExecutionError) Error() string

type Task

type Task interface {
	Name() string
	Run() error
	Rollback() error
}

type TaskRecorder

type TaskRecorder struct {
	TaskName           string
	RunSuccessful      bool
	RunExecuted        bool
	RollbackSuccessful bool
	RollbackExecuted   bool
}

func NewTaskRecorder

func NewTaskRecorder(taskName string, runSuccessful, rollbackSuccessful bool) *TaskRecorder

func (*TaskRecorder) Name

func (t *TaskRecorder) Name() string

func (*TaskRecorder) Rollback

func (t *TaskRecorder) Rollback() error

func (*TaskRecorder) Run

func (t *TaskRecorder) Run() error