processor

package

v0.0.0-...-0117b6e Latest Latest Go to latest Published: May 2, 2024 License: Apache-2.0 Imports: 18 Imported by: 7

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/aws/amazon-ssm-agent

Documentation ¶

Overview ¶

Package processor defines the document processing unit interface

Index ¶

func NewWorkerProcessorSpec(ctx context.T, workerLimit int, assignedDocType contracts.DocumentType, ...) *workerProcessorSpec
type EngineProcessor
- func NewEngineProcessor(ctx context.T, startWorker *workerProcessorSpec, ...) *EngineProcessor
type ErrorCode
type ExecuterCreator
type Processor

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewWorkerProcessorSpec ¶

func NewWorkerProcessorSpec(ctx context.T, workerLimit int, assignedDocType contracts.DocumentType, bufferLimit int) *workerProcessorSpec

NewWorkerProcessorSpec return new worker processor specification object reference

Types ¶

type EngineProcessor ¶

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

EngineProcessor defines methods to process the incoming document by pushing to the executor using JobPools

func NewEngineProcessor ¶

func NewEngineProcessor(ctx context.T, startWorker *workerProcessorSpec, cancelWorker *workerProcessorSpec) *EngineProcessor

NewEngineProcessor returns the newly initiated EngineProcessor TODO worker pool should be triggered in the Start() function supported document types indicate the domain of the documents 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) (errorCode ErrorCode)

Cancel pushes the command to CancelThread which is responsible for submitting to cancelCommandPool

func (*EngineProcessor) InitialProcessing ¶

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

func (*EngineProcessor) Start ¶

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

func (*EngineProcessor) Stop ¶

func (p *EngineProcessor) Stop()

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) (errorCode ErrorCode)

Submit submits to the pool a document in form of docState object, results will be streamed back from the channel returned by Start()

type ErrorCode ¶

type ErrorCode string

ErrorCode represents processor related error codes

const (

	// CommandBufferFull denotes that the cancel command buffer is full
	CommandBufferFull ErrorCode = "CommandBufferFull"

	// ClosedProcessor denotes that the processor is closed
	ClosedProcessor ErrorCode = "ClosedProcessor"

	// UnsupportedDocType represents unsupported doc type
	UnsupportedDocType ErrorCode = "UnsupportedDocType"

	// DuplicateCommand represents duplicate command in the buffer
	DuplicateCommand ErrorCode = "DuplicateCommand"

	// InvalidDocumentId represents invalid document id
	InvalidDocumentId ErrorCode = "InvalidDocumentId"

	// ConversionFailed represents conversion from pool to processor error code failed
	ConversionFailed ErrorCode = "ConversionFailed"

	// SubmissionPanic represents panic during submission to the pool
	SubmissionPanic ErrorCode = "SubmissionPanic"
)

type ExecuterCreator ¶

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

type Processor ¶

type Processor interface {
	//Start activate the Processor and pick up the leftover document in the last run, it returns a channel to caller to gather DocumentResult
	Start() (chan contracts.DocumentResult, error)
	//InitialProcessing processes any initial documents loaded from file directory. This should be run after Start().
	InitialProcessing(skipDocumentIfExpired bool) error
	//Stop the processor, save the current state to resume later
	Stop()
	//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) ErrorCode
	//Cancel cancels processing of the given document
	Cancel(docState contracts.DocumentState) ErrorCode
}

Source Files ¶

View all Source files

processor.go

Directories ¶

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

Path	Synopsis
executer Package executer provides interfaces as document execution logic	Package executer provides interfaces as document execution logic
basicexecuter Package basicexecuter provides interfaces as document execution logic	Package basicexecuter provides interfaces as document execution logic
iohandler Package iohandler implements the iohandler for the plugins	Package iohandler implements the iohandler for the plugins
iohandler/iomodule Package iomodule implements the output modules	Package iomodule implements the output modules
iohandler/iomodule/mock Package iomodulemock implements the mock iomodule	Package iomodulemock implements the mock iomodule
iohandler/mock Package iohandlermocks implements the mock iohandler	Package iohandlermocks implements the mock iohandler
iohandler/multiwriter Package multiwriter implements a multi-writer	Package multiwriter implements a multi-writer
iohandler/multiwriter/mock Package multiwritermock creates the mock mulitwriter	Package multiwritermock creates the mock mulitwriter
mock Package executer provides interfaces as document execution logic	Package executer provides interfaces as document execution logic
outofproc
outofproc/messaging
outofproc/proc Package process wraps up the os.Process interface and also provides os-specific process lookup functions	Package process wraps up the os.Process interface and also provides os-specific process lookup functions
outofproc/proc/mock
outofproc/sessionworker Package main implements a separate worker which is used to execute requests from session manager.	Package main implements a separate worker which is used to execute requests from session manager.
outofproc/worker
plugin Package plugin contains general interfaces and types relevant to plugins.	Package plugin contains general interfaces and types relevant to plugins.
mock