pipe

Documentation

Overview

Package pipe provides protocol processing pipelines.

Index

• type Engine
  • func NewEngine(lib *protocol.Library) *Engine
  • func (e *Engine) Execute(p *Pipeline, input []byte) ([]Result, error)
• type Pipeline
  • func ParsePipeline(data string) (*Pipeline, error)
  • func ParsePipelineShort(notation string) (*Pipeline, error)
• type Result
• type Stage

Types

type Engine

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

Engine executes pipelines.

func NewEngine

func NewEngine(lib *protocol.Library) *Engine

NewEngine creates a new pipeline engine.

func (*Engine) Execute

func (e *Engine) Execute(p *Pipeline, input []byte) ([]Result, error)

Execute runs a pipeline on the given input data.

type Pipeline

type Pipeline struct {
	Name   string  `json:"name"`
	Stages []Stage `json:"stages"`
}

Pipeline is a sequence of processing stages.

func ParsePipeline

func ParsePipeline(data string) (*Pipeline, error)

ParsePipeline parses a pipeline definition from JSON.

func ParsePipelineShort

func ParsePipelineShort(notation string) (*Pipeline, error)

ParsePipelineShort parses a short pipeline notation like "decode:IPv4|filter:version=4|encode:IPv4".

type Result

type Result struct {
	Stage   string `json:"stage"`
	Type    string `json:"type"`
	Data    any    `json:"data"`
	Success bool   `json:"success"`
	Error   string `json:"error,omitempty"`
}

Result holds the output of a pipeline execution.

type Stage

type Stage struct {
	Type     string            `json:"type"` // "decode", "filter", "transform", "encode"
	Protocol string            `json:"protocol,omitempty"`
	Config   map[string]string `json:"config,omitempty"`
}

Stage represents a pipeline processing stage.