From 94802725093e0b808229bef345a7acf12ffd6bfc Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Wed, 26 Mar 2025 19:07:16 -0700 Subject: [PATCH] doc: remove old lua flow methods Task #7489 --- doc/userguide/lua/lua-functions.rst | 92 ----------------------------- 1 file changed, 92 deletions(-) diff --git a/doc/userguide/lua/lua-functions.rst b/doc/userguide/lua/lua-functions.rst index fd35be7a7f..8570a029ec 100644 --- a/doc/userguide/lua/lua-functions.rst +++ b/doc/userguide/lua/lua-functions.rst @@ -57,98 +57,6 @@ flow return needs end -SCFlowTimestamps -~~~~~~~~~~~~~~~~ - -Get timestamps (seconds and microseconds) of the first and the last packet from -the flow. - -:: - - startts, lastts = SCFlowTimestamps() - startts_s, lastts_s, startts_us, lastts_us = SCFlowTimestamps() - -SCFlowTimeString -~~~~~~~~~~~~~~~~ - -:: - - startts = SCFlowTimeString() - -SCFlowTuple -~~~~~~~~~~~ - -:: - - ipver, srcip, dstip, proto, sp, dp = SCFlowTuple() - -SCFlowAppLayerProto -~~~~~~~~~~~~~~~~~~~ - -Get alproto as a string from the flow. If a alproto is not (yet) known, it -returns "unknown". - -Example: - -:: - - function log(args) - alproto = SCFlowAppLayerProto() - if alproto ~= nil then - print (alproto) - end - end - -Returns 5 values: - -Orig and expect are used when changing and upgrading protocols. In a SMTP STARTTLS -case, orig would normally be set to "smtp" and expect to "tls". - - -SCFlowHasAlerts -~~~~~~~~~~~~~~~ - -Returns true if flow has alerts. - -Example: - -:: - - function log(args) - has_alerts = SCFlowHasAlerts() - if has_alerts then - -- do something - end - end - -SCFlowStats -~~~~~~~~~~~ - -Gets the packet and byte counts per flow. - -:: - - tscnt, tsbytes, tccnt, tcbytes = SCFlowStats() - -SCFlowId -~~~~~~~~ - -Gets the flow id. - -:: - - id = SCFlowId() - -Note that simply printing 'id' will likely result in printing a scientific -notation. To avoid that, simply do: - -:: - - id = SCFlowId() - idstr = string.format("%.0f",id) - print ("Flow ID: " .. idstr .. "\n") - - http ---- -- 2.47.2