Documentation
¶
Index ¶
- func NewDefaultTaskContext(ctx gocontext.Context, basicRes context.BasicRes, name string, ...) plugin.TaskContext
- func NewStandaloneSubTaskContext(ctx gocontext.Context, basicRes context.BasicRes, name string, ...) plugin.SubTaskContext
- type DefaultBasicRes
- func (c *DefaultBasicRes) GetConfig(name string) string
- func (c *DefaultBasicRes) GetConfigReader() config.ConfigReader
- func (c *DefaultBasicRes) GetDal() dal.Dal
- func (c *DefaultBasicRes) GetLogger() log.Logger
- func (c *DefaultBasicRes) NestedLogger(name string) context.BasicRes
- func (c *DefaultBasicRes) ReplaceLogger(logger log.Logger) context.BasicRes
- type DefaultSubTaskContext
- func (c DefaultSubTaskContext) GetContext() gocontext.Context
- func (c DefaultSubTaskContext) GetData() interface{}
- func (c DefaultSubTaskContext) GetName() string
- func (c *DefaultSubTaskContext) IncProgress(quantity int)
- func (c *DefaultSubTaskContext) SetProgress(current int, total int)
- func (c *DefaultSubTaskContext) TaskContext() plugin.TaskContext
- type DefaultTaskContext
- func (c DefaultTaskContext) GetContext() gocontext.Context
- func (c DefaultTaskContext) GetData() interface{}
- func (c DefaultTaskContext) GetName() string
- func (c *DefaultTaskContext) IncProgress(quantity int)
- func (c *DefaultTaskContext) SetData(data interface{})
- func (c *DefaultTaskContext) SetProgress(current int, total int)
- func (c *DefaultTaskContext) SubTaskContext(subtask string) (plugin.SubTaskContext, errors.Error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewDefaultTaskContext ¶
func NewDefaultTaskContext( ctx gocontext.Context, basicRes context.BasicRes, name string, subtasks map[string]bool, progress chan plugin.RunningProgress, ) plugin.TaskContext
NewDefaultTaskContext holds everything needed by the task execution.
func NewStandaloneSubTaskContext ¶
func NewStandaloneSubTaskContext( ctx gocontext.Context, basicRes context.BasicRes, name string, data interface{}, ) plugin.SubTaskContext
NewStandaloneSubTaskContext returns a stand-alone plugin.SubTaskContext, not attached to any plugin.TaskContext. Use this if you need to run/debug a subtask without going through the usual workflow.
Types ¶
type DefaultBasicRes ¶
type DefaultBasicRes struct {
// contains filtered or unexported fields
}
DefaultBasicRes offers a common implementation for the BasisRes interface
func NewDefaultBasicRes ¶
func NewDefaultBasicRes( cfg config.ConfigReader, logger log.Logger, db dal.Dal, ) *DefaultBasicRes
NewDefaultBasicRes creates a new DefaultBasicRes instance
func (*DefaultBasicRes) GetConfig ¶
func (c *DefaultBasicRes) GetConfig(name string) string
GetConfig returns the value of the specificed name
func (*DefaultBasicRes) GetConfigReader ¶
func (c *DefaultBasicRes) GetConfigReader() config.ConfigReader
GetConfigReader returns the ConfigReader instance
func (*DefaultBasicRes) GetDal ¶
func (c *DefaultBasicRes) GetDal() dal.Dal
GetDal returns the Dal instance
func (*DefaultBasicRes) GetLogger ¶
func (c *DefaultBasicRes) GetLogger() log.Logger
GetLogger returns the Logger instance
func (*DefaultBasicRes) NestedLogger ¶
func (c *DefaultBasicRes) NestedLogger(name string) context.BasicRes
NestedLogger returns a new DefaultBasicRes with a new nested logger
func (*DefaultBasicRes) ReplaceLogger ¶
func (c *DefaultBasicRes) ReplaceLogger(logger log.Logger) context.BasicRes
ReplaceLogger returns a new DefaultBasicRes with the specified logger
type DefaultSubTaskContext ¶
type DefaultSubTaskContext struct {
LastProgressTime time.Time
// contains filtered or unexported fields
}
DefaultSubTaskContext is default implementation
func (DefaultSubTaskContext) GetContext ¶
func (*DefaultSubTaskContext) IncProgress ¶
func (c *DefaultSubTaskContext) IncProgress(quantity int)
IncProgress FIXME ...
func (*DefaultSubTaskContext) SetProgress ¶
func (c *DefaultSubTaskContext) SetProgress(current int, total int)
SetProgress FIXME ...
func (*DefaultSubTaskContext) TaskContext ¶
func (c *DefaultSubTaskContext) TaskContext() plugin.TaskContext
TaskContext FIXME ...
type DefaultTaskContext ¶
type DefaultTaskContext struct {
// contains filtered or unexported fields
}
DefaultTaskContext is TaskContext default implementation
func (DefaultTaskContext) GetContext ¶
func (*DefaultTaskContext) IncProgress ¶
func (c *DefaultTaskContext) IncProgress(quantity int)
IncProgress FIXME ...
func (*DefaultTaskContext) SetData ¶
func (c *DefaultTaskContext) SetData(data interface{})
SetData FIXME ...
func (*DefaultTaskContext) SetProgress ¶
func (c *DefaultTaskContext) SetProgress(current int, total int)
SetProgress FIXME ...
func (*DefaultTaskContext) SubTaskContext ¶
func (c *DefaultTaskContext) SubTaskContext(subtask string) (plugin.SubTaskContext, errors.Error)
SubTaskContext FIXME ...
Source Files