flow

package

Go to main page

Versions in this module

v2

v2.16.0

Nov 1, 2024

v2.15.0

Oct 8, 2024

v2.14.0

Dec 29, 2023

v2.13.0

Nov 8, 2023

v2.12.0

Jun 27, 2023

v2.11.0

May 22, 2023

v2.10.0

Mar 1, 2023

v2.9.2

Dec 27, 2022

v2.9.1

Dec 1, 2022

Changes in this version

+ func NewBlockLimit(limitCount int, options ...AutoLimitOption) limit.BlockLimit

+ type AutoLimitOption func(l *autoLimit)

+ func IncreaseLimitCount(count int) AutoLimitOption

+ func IncreaseLimitCountPeriod(period time.Duration) AutoLimitOption

+ func MaxLimitCount(count int) AutoLimitOption

+ func MinLimitCount(count int) AutoLimitOption

type Flow

+ DoWorkInfoListMinCount int

+ Limit limit.BlockLimit

type FlowBuilder

+ func (b *FlowBuilder) DoWorkListMinCount(count int) *FlowBuilder

+ func (b *FlowBuilder) SetLimit(limit limit.BlockLimit) *FlowBuilder

type Info

+ MinWorkerCount int

+ WorkerCountIncreasePeriod int

v2.9.0

Aug 5, 2022

Changes in this version

type FlowBuilder

+ func (b *FlowBuilder) SetOverseerEnable(enable bool) *FlowBuilder

v2.8.0

Jun 27, 2022

Changes in this version

type FlowBuilder

+ func (b *FlowBuilder) SetDBOverseer(dbPath string, blankWorkRecordBuilder func() *WorkRecord) *FlowBuilder

+ func (b *FlowBuilder) SetOverseer(overseer Overseer) *FlowBuilder

type Result

+ IsValid func() bool

type WorkProvideBuilder

+ func (b *WorkProvideBuilder) WorkProviderWithChan(works <-chan Work) *WorkerProvideBuilder

type WorkProvider

+ func NewChanWorkProvider(works <-chan Work) (WorkProvider, *data.CodeError)

v2.7.0

May 27, 2022

Changes in this version

+ const DefaultLineItemSeparate

+ const ErrorSeparate

+ const UnknownWorkCount

+ func UserCodeVerification() (success bool)

+ type EventListener struct

+ FlowWillEndFunc func(flow *Flow) (err *data.CodeError)

+ FlowWillStartFunc func(flow *Flow) (err *data.CodeError)

+ OnWorkFailFunc func(work *WorkInfo, err *data.CodeError)

+ OnWorkSkipFunc func(work *WorkInfo, err *data.CodeError)

+ OnWorkSuccessFunc func(work *WorkInfo, result Result)

+ WillWorkFunc func(work *WorkInfo) (shouldContinue bool, err *data.CodeError)

+ func (e *EventListener) FlowWillEnd(flow *Flow) (err *data.CodeError)

+ func (e *EventListener) FlowWillStart(flow *Flow) (err *data.CodeError)

+ func (e *EventListener) OnWorkFail(work *WorkInfo, err *data.CodeError)

+ func (e *EventListener) OnWorkSkip(work *WorkInfo, err *data.CodeError)

+ func (e *EventListener) OnWorkSuccess(work *WorkInfo, result Result)

+ func (e *EventListener) WillWork(work *WorkInfo) (shouldContinue bool, err *data.CodeError)

+ type Flow struct

+ DoWorkInfoListMaxCount int

+ EventListener EventListener

+ Info Info

+ Overseer Overseer

+ Redo Redo

+ Skipper Skipper

+ WorkProvider WorkProvider

+ WorkerProvider WorkerProvider

+ func (f *Flow) Check() *data.CodeError

+ func (f *Flow) Start()

+ type FlowBuilder struct

+ func (b *FlowBuilder) Build() *Flow

+ func (b *FlowBuilder) DoWorkListMaxCount(count int) *FlowBuilder

+ func (b *FlowBuilder) FlowWillEndFunc(f func(flow *Flow) (err *data.CodeError)) *FlowBuilder

+ func (b *FlowBuilder) FlowWillStartFunc(f func(flow *Flow) (err *data.CodeError)) *FlowBuilder

+ func (b *FlowBuilder) OnWillWork(f func(workInfo *WorkInfo) (shouldContinue bool, err *data.CodeError)) *FlowBuilder

+ func (b *FlowBuilder) OnWorkFail(f func(workInfo *WorkInfo, err *data.CodeError)) *FlowBuilder

+ func (b *FlowBuilder) OnWorkSkip(f func(workInfo *WorkInfo, err *data.CodeError)) *FlowBuilder

+ func (b *FlowBuilder) OnWorkSuccess(f func(workInfo *WorkInfo, result Result)) *FlowBuilder

+ func (b *FlowBuilder) ShouldRedo(...) *FlowBuilder

+ func (b *FlowBuilder) ShouldSkip(f func(workInfo *WorkInfo) (skip bool, cause *data.CodeError)) *FlowBuilder

+ type Info struct

+ Force bool

+ StopWhenWorkError bool

+ WorkerCount int

+ func (i *Info) Check() *data.CodeError

+ type Overseer interface

+ GetWorkRecordIfHasDone func(work *WorkInfo) (hasDone bool, record *WorkRecord)

+ WillWork func(work *WorkInfo)

+ WorkDone func(record *WorkRecord)

+ func NewDBRecordOverseer(dbPath string, blankWorkRecordBuilder func() *WorkRecord) (Overseer, *data.CodeError)

+ type Redo interface

+ ShouldRedo func(work *WorkInfo, workRecord *WorkRecord) (shouldRedo bool, cause *data.CodeError)

+ func NewRedo(...) Redo

+ type Result interface

+ type Skipper interface

+ ShouldSkip func(work *WorkInfo) (skip bool, cause *data.CodeError)

+ func NewSkipper(f func(work *WorkInfo) (skip bool, cause *data.CodeError)) Skipper

+ type Work interface

+ WorkId func() string

+ type WorkCreator interface

+ Create func(info string) (work Work, err *data.CodeError)

+ func NewItemsWorkCreator(separate string, minItemsCount int, ...) WorkCreator

+ func NewJsonWorkCreator(blankQuotedWorkCreatFunc func() Work) WorkCreator

+ type WorkInfo struct

+ Data string

+ Work Work

+ type WorkProvideBuilder struct

+ func New(info Info) *WorkProvideBuilder

+ func (b *WorkProvideBuilder) WorkProvider(provider WorkProvider) *WorkerProvideBuilder

+ func (b *WorkProvideBuilder) WorkProviderWithArray(workList []Work) *WorkerProvideBuilder

+ func (b *WorkProvideBuilder) WorkProviderWithFile(filePath string, enableStdin bool, creator WorkCreator) *WorkerProvideBuilder

+ type WorkProvider interface

+ Provide func() (hasMore bool, work *WorkInfo, err *data.CodeError)

+ WorkTotalCount func() int64

+ func NewArrayWorkProvider(works []Work) (WorkProvider, *data.CodeError)

+ func NewFileWorkProvider(filePath string, creator WorkCreator) (WorkProvider, *data.CodeError)

+ func NewReaderWorkProvider(reader io.Reader, creator WorkCreator) (WorkProvider, *data.CodeError)

+ func NewWorkProviderOfFile(filepath string, enableStdin bool, creator WorkCreator) (provider WorkProvider, err *data.CodeError)

+ type WorkRecord struct

+ Err *data.CodeError

+ Result Result

+ type Worker interface

+ DoWork func(workInfos []*WorkInfo) (recordList []*WorkRecord, err *data.CodeError)

+ func NewSimpleWorker(doFunc func(workInfo *WorkInfo) (Result, *data.CodeError)) Worker

+ func NewWorker(doFunc func(workInfos []*WorkInfo) ([]*WorkRecord, *data.CodeError)) Worker

+ type WorkerProvideBuilder struct

+ func (b *WorkerProvideBuilder) WorkerProvider(provider WorkerProvider) *FlowBuilder

+ type WorkerProvider interface

+ Provide func() (worker Worker, err *data.CodeError)

+ func NewWorkerProvider(builder func() (Worker, *data.CodeError)) WorkerProvider

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL