asyncjob

Dec 12, 2022

Changes in this version

+ const ErrAddExistingStep

+ const ErrDuplicateInputParentStep

+ const ErrPrecedentStepFailed

+ const ErrRuntimeStepNotFound

+ const MsgAddExistingStep

+ const MsgAddStepInSealedJob

+ const MsgDuplicateInputParentStep

+ const MsgRefStepNotInJob

+ const MsgRuntimeStepNotFound

type JobDefinitionMeta

+ Visualize func() (string, error)

type JobErrorCode

+ func (code JobErrorCode) WithMessage(msg string) *MessageError

type JobInstanceMeta

+ GetJobInstanceId func() string

+ Visualize func() (string, error)

+ type MessageError struct

+ Code JobErrorCode

+ Message string

+ func (me *MessageError) Error() string

+ func (me *MessageError) Unwrap() error

Dec 11, 2022

Changes in this version

type ExecutionOptionPreparer

+ func WithContextEnrichment(contextPolicy StepContextPolicy) ExecutionOptionPreparer

+ type JobDefinition struct

+ func NewJobDefinition(name string) *JobDefinition[T]

+ func (jd *JobDefinition[T]) GetName() string

+ func (jd *JobDefinition[T]) GetStep(stepName string) (StepDefinitionMeta, bool)

+ func (jd *JobDefinition[T]) Seal()

+ func (jd *JobDefinition[T]) Sealed() bool

+ func (jd *JobDefinition[T]) Start(ctx context.Context, input *T, jobOptions ...JobOptionPreparer) *JobInstance[T]

+ func (jd *JobDefinition[T]) Visualize() (string, error)

+ type JobDefinitionMeta interface

+ GetName func() string

+ GetStep func(stepName string) (StepDefinitionMeta, bool)

+ Seal func()

+ Sealed func() bool

+ type JobDefinitionWithResult struct

+ func JobWithResult(jd *JobDefinition[Tin], resultStep *StepDefinition[Tout]) (*JobDefinitionWithResult[Tin, Tout], error)

+ func (jd *JobDefinitionWithResult[Tin, Tout]) Start(ctx context.Context, input *Tin) *JobInstanceWithResult[Tin, Tout]

type JobError

+ StepInstance StepInstanceMeta

+ func (je *JobError) RootCause() error

type JobErrorCode

+ const ErrAddStepInSealedJob

+ const ErrRefStepNotInJob

+ type JobExecutionOptions struct

+ Id string

+ RunSequentially bool

+ type JobInstance struct

+ Definition *JobDefinition[T]

+ func (jd *JobInstance[T]) Visualize() (string, error)

+ func (ji *JobInstance[T]) GetJobDefinition() JobDefinitionMeta

+ func (ji *JobInstance[T]) GetJobInstanceId() string

+ func (ji *JobInstance[T]) GetStepInstance(stepName string) (StepInstanceMeta, bool)

+ func (ji *JobInstance[T]) Wait(ctx context.Context) error

+ type JobInstanceMeta interface

+ GetJobDefinition func() JobDefinitionMeta

+ GetStepInstance func(stepName string) (StepInstanceMeta, bool)

+ Wait func(context.Context) error

+ type JobInstanceWithResult struct

+ func (ji *JobInstanceWithResult[Tin, Tout]) Result(ctx context.Context) (*Tout, error)

+ type JobOptionPreparer func(*JobExecutionOptions) *JobExecutionOptions

+ func WithJobId(jobId string) JobOptionPreparer

+ func WithSequentialExecution() JobOptionPreparer

+ type StepDefinition struct

+ func AddStepWithStaticFunc(bCtx context.Context, j *JobDefinition[JT], stepName string, ...) (*StepDefinition[ST], error)

+ func StepAfterBothWithStaticFunc(bCtx context.Context, j *JobDefinition[JT], stepName string, ...) (*StepDefinition[ST], error)

+ func StepAfterWithStaticFunc(bCtx context.Context, j *JobDefinition[JT], stepName string, ...) (*StepDefinition[ST], error)

+ func (sd *StepDefinition[T]) DependsOn() []string

+ func (sd *StepDefinition[T]) DotSpec() *graph.DotNodeSpec

+ func (sd *StepDefinition[T]) ExecutionPolicy() *StepExecutionOptions

+ func (sd *StepDefinition[T]) GetName() string

+ type StepDefinitionMeta interface

+ DependsOn func() []string

+ DotSpec func() *graph.DotNodeSpec

+ ExecutionPolicy func() *StepExecutionOptions

+ GetName func() string

+ type StepInstance struct

+ Definition *StepDefinition[T]

+ JobInstance JobInstanceMeta

+ func (si *StepInstance[T]) DotSpec() *graph.DotNodeSpec

+ func (si *StepInstance[T]) EnrichContext(ctx context.Context) (result context.Context)

+ func (si *StepInstance[T]) ExecutionData() *StepExecutionData

+ func (si *StepInstance[T]) GetJobInstance() JobInstanceMeta

+ func (si *StepInstance[T]) GetName() string

+ func (si *StepInstance[T]) GetState() StepState

+ func (si *StepInstance[T]) GetStepDefinition() StepDefinitionMeta

+ func (si *StepInstance[T]) Waitable() asynctask.Waitable

+ type StepInstanceMeta interface

+ DotSpec func() *graph.DotNodeSpec

+ ExecutionData func() *StepExecutionData

+ GetJobInstance func() JobInstanceMeta

+ GetName func() string

+ GetState func() StepState

+ GetStepDefinition func() StepDefinitionMeta

+ Waitable func() asynctask.Waitable

Nov 7, 2022

Changes in this version

type ExecutionOptionPreparer

+ func WithEnrichedContext(contextPolicy StepContextPolicy) ExecutionOptionPreparer

+ func WithRetry(retryPolicy RetryPolicy) ExecutionOptionPreparer

+ func WithTimeout(timeout time.Duration) ExecutionOptionPreparer

type Job

+ func (j *Job) AddStep(step StepMeta, precedingSteps ...StepMeta)

+ func (j *Job) GetStep(stepName string) (StepMeta, bool)

+ func (j *Job) RootStep() *StepInfo[interface{}]

+ func (j *Job) RuntimeContext() context.Context

+ type JobError struct

+ Code JobErrorCode

+ Message string

+ StepError error

+ StepName string

+ func (je *JobError) Error() string

+ func (je *JobError) Unwrap() error

+ type JobErrorCode string

+ const ErrPrecedentStepFailure

+ const ErrStepFailed

+ func (code JobErrorCode) Error() string

+ type JobInterface interface

+ AddStep func(step StepMeta, precedingSteps ...StepMeta)

+ GetStep func(stepName string) (StepMeta, bool)

+ RootStep func() *StepInfo[interface{}]

+ RuntimeContext func() context.Context

+ Start func(ctx context.Context) error

+ type RetryPolicy interface

+ ShouldRetry func(error) bool

+ SleepInterval func() time.Duration

+ type RetryReport struct

+ Count int

+ type StepContextPolicy func(context.Context) context.Context

type StepExecutionData

+ Retried *RetryReport

type StepExecutionOptions

+ ContextPolicy StepContextPolicy

Nov 1, 2022

Changes in this version

+ type StepExecutionData struct

+ Duration time.Duration

+ StartTime time.Time

type StepInfo

+ func (si *StepInfo[T]) ExecutionData() *StepExecutionData

type StepMeta

+ ExecutionData func() *StepExecutionData

Oct 26, 2022

Changes in this version

type ExecutionOptionPreparer

+ func ExecuteAfter(step StepMeta) ExecutionOptionPreparer

type StepExecutionOptions

+ DependOn []string

type StepInfo

+ func (si *StepInfo[T]) GetName() string

type StepMeta

+ GetName func() string

Jul 7, 2022

Changes in this version

+ type ExecutionOptionPreparer func(*StepExecutionOptions) *StepExecutionOptions

+ type Job struct

+ Name string

+ Steps map[string]StepMeta

+ func NewJob(name string) *Job

+ func (j *Job) Start(ctx context.Context) error

+ func (j *Job) Visualize() string

+ func (j *Job) Wait(ctx context.Context) error

+ type JobBuilder interface

+ BuildJob func(context.Context) *Job

+ type JobState string

+ const JobStateCompleted

+ const JobStatePending

+ const JobStateRunning

+ type StepErrorPolicy struct

+ type StepExecutionOptions struct

+ ErrorPolicy StepErrorPolicy

+ RetryPolicy StepRetryPolicy

+ Timeout time.Duration

+ type StepInfo struct

+ func AddStep(bCtx context.Context, j *Job, stepName string, stepFunc asynctask.AsyncFunc[T], ...) (*StepInfo[T], error)

+ func InputParam(bCtx context.Context, j *Job, stepName string, value *T) *StepInfo[T]

+ func StepAfter(bCtx context.Context, j *Job, stepName string, parentStep *StepInfo[T], ...) (*StepInfo[S], error)

+ func StepAfterBoth(bCtx context.Context, j *Job, stepName string, parentStepT *StepInfo[T], ...) (*StepInfo[R], error)

+ func (si *StepInfo[T]) DependsOn() []string

+ func (si *StepInfo[T]) ExecutionPolicy() *StepExecutionOptions

+ func (si *StepInfo[T]) GetState() StepState

+ func (si *StepInfo[T]) Name() string

+ func (si *StepInfo[T]) Wait(ctx context.Context) error

+ func (si *StepInfo[T]) Waitable() asynctask.Waitable

+ type StepMeta interface

+ DependsOn func() []string

+ ExecutionPolicy func() *StepExecutionOptions

+ GetState func() StepState

+ Name func() string

+ Wait func(context.Context) error

+ Waitable func() asynctask.Waitable

+ type StepRetryPolicy struct

+ type StepState string

+ const StepStateCompleted

+ const StepStateFailed

+ const StepStatePending

+ const StepStateRunning