processor

Documentation

Overview

Package processor defines the document processing unit interface

Index

• type EngineProcessor
  • func NewEngineProcessor(ctx context.T, commandWorkerLimit int, cancelWorkerLimit int, ...) *EngineProcessor
  • func (p *EngineProcessor) Cancel(docState contracts.DocumentState)
  • func (p *EngineProcessor) InitialProcessing() (err error)
  • func (p *EngineProcessor) Start() (resChan chan contracts.DocumentResult, err error)
  • func (p *EngineProcessor) Stop(stopType contracts.StopType)
  • func (p *EngineProcessor) Submit(docState contracts.DocumentState)
• type ExecuterCreator
• type Processor

Types

type EngineProcessor

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

func NewEngineProcessor

func NewEngineProcessor(ctx context.T, commandWorkerLimit int, cancelWorkerLimit int, supportedDocs []contracts.DocumentType) *EngineProcessor

TODO worker pool should be triggered in the Start() function supported document types indicate the domain of the documentes the Processor with run upon. There'll be race-conditions if there're multiple Processors in a certain domain.

func (*EngineProcessor) Cancel

func (p *EngineProcessor) Cancel(docState contracts.DocumentState)

func (*EngineProcessor) InitialProcessing

func (p *EngineProcessor) InitialProcessing() (err error)

func (*EngineProcessor) Start

func (p *EngineProcessor) Start() (resChan chan contracts.DocumentResult, err error)

func (*EngineProcessor) Stop

func (p *EngineProcessor) Stop(stopType contracts.StopType)

Stop set the cancel flags of all the running jobs, which are to be captured by the command worker and shutdown gracefully

func (*EngineProcessor) Submit

func (p *EngineProcessor) Submit(docState contracts.DocumentState)

Submit() is the public interface for sending run document request to processor

type ExecuterCreator

type ExecuterCreator func(ctx context.T) executer.Executer

type Processor

type Processor interface {
	//Start activate the Processor and pick up the left over document in the last run, it returns a channel to caller to gather DocumentResult
	Start() (chan contracts.DocumentResult, error)
	//Process any initial documents loaded from file directory. This should be run after Start().
	InitialProcessing() error
	//Stop the processor, save the current state to resume later
	Stop(stopType contracts.StopType)
	//submit to the pool a document in form of docState object, results will be streamed back from the central channel returned by Start()
	Submit(docState contracts.DocumentState)
	//cancel process the cancel document, with no return value since the command is already tracked in a different thread
	Cancel(docState contracts.DocumentState)
}