lua

package
v0.35.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 24, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const FunctionNameFilter = "Filter"

FunctionNameFilter is the name of the function to be called in the script

Variables

This section is empty.

Functions

This section is empty.

Types

type LuaFilter

type LuaFilter struct {
	Config LuaFilterConfiguration
	// contains filtered or unexported fields
}

LuaFilter is a component that filters messages based on Lua scripts.

func (*LuaFilter) Destroy

func (x *LuaFilter) Destroy()

Destroy releases the resources of the component

func (*LuaFilter) Init

func (x *LuaFilter) Init(ruleConfig types.Config, configuration types.Configuration) error

Init initializes the component

func (*LuaFilter) New

func (x *LuaFilter) New() types.Node

New creates a new instance of LuaFilter

func (*LuaFilter) OnMsg

func (x *LuaFilter) OnMsg(ctx types.RuleContext, msg types.RuleMsg)

OnMsg handles the message

func (*LuaFilter) Type

func (x *LuaFilter) Type() string

Type returns the type of the component

type LuaFilterConfiguration

type LuaFilterConfiguration struct {
	//Script configures the function body content or the script file path with `.lua` as the suffix
	//Only need to provide the function body content, if it is a file path, then need to provide the complete script function:
	//function Filter(msg, metadata, msgType, dataType) ${Script} \n end
	//return bool
	//The parameter msg, if the data type of msg is JSON, then it will be converted to the Lua table type before calling the function
	//If the data type of msg is BINARY, then it will be converted to a Lua userdata (byte array) before calling the function
	Script string
}

LuaFilterConfiguration node configuration

Jump to

Keyboard shortcuts

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