component

Documentation

Index

• Constants
• type Component
• type Factory
• type Message
• type Report

Constants

const (
	// Done is the status code for indicating that the message has been
	// successfuly handled and should be sent to the next component
	Done = 0

	// Continue is the status code for indicating that the message has been
	// successfuly handled, but should not be sent to the next component
	Continue = 1

	// Retry is the status code for indicating that the worker has failed to
	// handle the message and should be retried again.
	Retry = 100

	// Fail is the status code for indicating that the worker has failed to
	// handle the message and should not be retried again.
	Fail = 200

	// Drop is the status code for indicating that the message has been discarded
	// by the worker and also shuold be
	Drop = 300
)

Types

type Component

type Component interface {
	Handle(Message) *Report
}

Component represents any element in the pipeline that performs some work on a message.

A component should return a *Report containing the status of the action performed.

type Factory

type Factory interface {
	Create(postponed chan Message) Component
	Destroy()
	SetAttribute(key string, value interface{}) error
	PoolSize() int
	ChannelSize() int
}

Factory is used to create instances of Components

type Message

type Message interface {
	GetData() interface{}
	SetData(interface{})
	GetAttribute(string) interface{}
	SetAttribute(string, interface{})
	Status() *Report
	Release()
}

Message wraps the data sent through the pipeline

type Report

type Report struct {
	Status      int
	Description string
}

Report contains information about the result of processing a message