cbcli

Documentation

Index

• Variables
• type Config
• type ErrorAfterDurationTask
• type ErrorHandler
• type GoroutineConfigurableTask
• type Logger
• type ScheduledTask
• type Task
• type TaskContainer
  • func New() *TaskContainer
  • func (t *TaskContainer) AddTask(task Task)
  • func (t *TaskContainer) DispatchTasks()
  • func (t *TaskContainer) Execute() error
  • func (t *TaskContainer) RunTask(group, name string) error
  • func (t *TaskContainer) SetConfig(config Config)
  • func (t *TaskContainer) SetDispatchEnvironment(envs []string)
  • func (t *TaskContainer) SetErrorHandler(handler ErrorHandler)
  • func (t *TaskContainer) SetLogger(logger Logger)

Variables

var TaskNotFound = errors.New("task not found")

Types

type Config

type Config interface {
	/**
	first return type is whether the config is enabled
	second return type is an error when the config path is not defined
	the path passed in will be in the format: cbcli.group.name
	where group and name are replaced with the task's returned values
	*/
	GetRequiredBool(path string) (bool, error)
}

type ErrorAfterDurationTask

type ErrorAfterDurationTask interface {
	GetErrorAfterDuration() time.Duration
}

type ErrorHandler

type ErrorHandler interface {
	Error(e error)
	Recover()
}

type GoroutineConfigurableTask

type GoroutineConfigurableTask interface {
	ExecuteInGoroutine() bool
}

type Logger

type Logger interface {
	InfoF(category string, message string, args ...interface{})
	Write(message []byte) (n int, e error)
}

type ScheduledTask

type ScheduledTask interface {
	GetSchedule() string
}

type Task

type Task interface {
	GetGroup() string
	GetName() string
	Run() error
}

type TaskContainer

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

func New

func New() *TaskContainer

func (*TaskContainer) AddTask

func (t *TaskContainer) AddTask(task Task)

func (*TaskContainer) DispatchTasks

func (t *TaskContainer) DispatchTasks()

func (*TaskContainer) Execute

func (t *TaskContainer) Execute() error

func (*TaskContainer) RunTask

func (t *TaskContainer) RunTask(group, name string) error

func (*TaskContainer) SetConfig

func (t *TaskContainer) SetConfig(config Config)

func (*TaskContainer) SetDispatchEnvironment

func (t *TaskContainer) SetDispatchEnvironment(envs []string)

func (*TaskContainer) SetErrorHandler

func (t *TaskContainer) SetErrorHandler(handler ErrorHandler)

func (*TaskContainer) SetLogger

func (t *TaskContainer) SetLogger(logger Logger)