pipeline

type APIEntry struct {
	Path    string
	Method  string
	Handler http.HandlerFunc
}

type Filter interface {
	// Kind returns the unique kind name to represent itself.
	Kind() string

	// DefaultSpec returns the default spec.
	DefaultSpec() interface{}

	// Description returns the description of the filter.
	Description() string

	// Results returns all possible results, excluding the default result value (empty string).
	Results() []string

	// Init initializes the Filter.
	Init(filterSpec *FilterSpec)

	// Inherit also initializes the Filter.
	// But it needs to handle the lifecycle of the previous generation.
	// So it is Filter's responsibility to inherit and clean the previous generation.
	// The http pipeline won't call Close for the previous generation.
	Inherit(filterSpec *FilterSpec, previousGeneration Filter)

	// Status returns its runtime status.
	// It could return nil.
	Status() interface{}

	// Close closes itself.
	Close()
}

type FilterMetaSpec struct {
	Name     string           `yaml:"name" jsonschema:"required,format=urlname"`
	Kind     string           `yaml:"kind" jsonschema:"required"`
	Pipeline string           `yaml:"-" jsonschema:"-"`
	Protocol context.Protocol `yaml:"-" jsonschema:"-"`
}

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

type Flow struct {
	Filter string `yaml:"filter" jsonschema:"required,format=urlname"`
}

type HTTPFilter interface {
	Filter

	// Handle handles one HTTP request, all possible results
	// need be registered in Results.
	HandleHTTP(context.HTTPContext) *context.HTTPResult
}

type MQTTFilter interface {
	Filter

	// Handle handles one MQTT request, all possible results
	// need be registered in Results.
	HandleMQTT(context.MQTTContext) *context.MQTTResult
}

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

type MockMQTTSpec struct {
	UserName    string   `yaml:"userName" jsonschema:"required"`
	Password    string   `yaml:"password" jsonschema:"required"`
	Port        uint16   `yaml:"port" jsonschema:"required"`
	BackendType string   `yaml:"backendType" jsonschema:"required"`
	EarlyStop   bool     `yaml:"earlyStop" jsonschema:"omitempty"`
	KeysToStore []string `yaml:"keysToStore" jsonschema:"omitempty"`
	ConnectKey  string   `yaml:"connectKey" jsonschema:"omitempty"`
}

type MockMQTTStatus struct {
	ClientCount      map[string]int
	ClientDisconnect map[string]struct{}
	Subscribe        map[string][]string
	Unsubscribe      map[string][]string
}

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

type Spec struct {
	Name     string                   `yaml:"-" jsonschema:"-"`
	Protocol context.Protocol         `yaml:"protocol" jsonschema:"required"`
	Flow     []Flow                   `yaml:"flow" jsonschema:"omitempty"`
	Filters  []map[string]interface{} `yaml:"filters" jsonschema:"required"`
}

type Status struct {
	Health string `yaml:"health"`

	Filters map[string]interface{} `yaml:"filters"`
}

type TCPFilter interface {
	Filter

	HandleTCP(context.TCPContext) *context.TCPResult
}

type UDPFilter interface {
	Filter
	HandleUDP(context.UDPContext) *context.UDPResult
}