splitter

Documentation

Index

• type Engine
  • func New(log zerolog.Logger, channel network.Channel) *Engine
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) Process(channel network.Channel, originID flow.Identifier, event interface{}) error
  • func (e *Engine) ProcessLocal(event interface{}) error
  • func (e *Engine) Ready() <-chan struct{}
  • func (e *Engine) RegisterEngine(engine module.Engine)
  • func (e *Engine) Submit(channel network.Channel, originID flow.Identifier, event interface{})
  • func (e *Engine) SubmitLocal(event interface{})
  • func (e *Engine) UnregisterEngine(engine module.Engine)

Types

type Engine

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

Engine is the splitter engine, which maintains a list of registered engines and passes every event it receives to each of these engines in parallel.

func New

func New(
	log zerolog.Logger,
	channel network.Channel,
) *Engine

New creates a new splitter engine.

func (*Engine) Done

func (e *Engine) Done() <-chan struct{}

Done returns a done channel that is closed once the engine has fully stopped.

func (*Engine) Process

func (e *Engine) Process(channel network.Channel, originID flow.Identifier, event interface{}) error

Process processes the given event from the node with the given origin ID in a blocking manner. It returns the potential processing error when done.

func (*Engine) ProcessLocal

func (e *Engine) ProcessLocal(event interface{}) error

ProcessLocal processes an event originating on the local node.

func (*Engine) Ready

func (e *Engine) Ready() <-chan struct{}

Ready returns a ready channel that is closed once the engine has fully started.

func (*Engine) RegisterEngine

func (e *Engine) RegisterEngine(engine module.Engine)

RegisterEngine registers a new engine with the splitter. Events that are received by the splitter after the engine has registered will be passed down to it.

func (*Engine) Submit

func (e *Engine) Submit(channel network.Channel, originID flow.Identifier, event interface{})

Submit submits the given event from the node with the given origin ID for processing in a non-blocking manner. It returns instantly and logs a potential processing error internally when done.

func (*Engine) SubmitLocal

func (e *Engine) SubmitLocal(event interface{})

SubmitLocal submits an event originating on the local node.

func (*Engine) UnregisterEngine

func (e *Engine) UnregisterEngine(engine module.Engine)

UnregisterEngine unregisters an engine with the splitter. After the engine has been unregistered, the splitter will stop passing events to it. If the given engine was never registered, this is a noop.