diff options
author | Peter Wu <peter@lekensteyn.nl> | 2016-10-17 02:08:44 +0200 |
---|---|---|
committer | Anders Broman <a.broman58@gmail.com> | 2016-10-18 04:09:14 +0000 |
commit | 8a1adf1a66cb0324e418e2e588cf47c68c4a287a (patch) | |
tree | aecd0a2c6c3805b98445f4a17c1d076f07d7f3f5 /docbook/wsluarm.asciidoc | |
parent | f07b1bc6042925cba6ca2bfb762c9521513259ba (diff) | |
download | wireshark-8a1adf1a66cb0324e418e2e588cf47c68c4a287a.tar.gz |
wslua: fix errors in documentation, add notational conventions
Improve example with better formatting, clarification comments and more
common variable names.
Extend make-wsluarm.pl to support arguments containing underscores.
Fixes the description of dissect_tcp_pdus.
Change TvbRange.tvb(tvb) into tvbrange:tvb() and ByteArray.tvb(name)
into bytearray:tvb(name), these are really instance methods.
Change-Id: I1e20ef46195dc6c06f9ac790d3432db283d21a5e
Reviewed-on: https://code.wireshark.org/review/18226
Reviewed-by: Anders Broman <a.broman58@gmail.com>
Diffstat (limited to 'docbook/wsluarm.asciidoc')
-rw-r--r-- | docbook/wsluarm.asciidoc | 54 |
1 files changed, 39 insertions, 15 deletions
diff --git a/docbook/wsluarm.asciidoc b/docbook/wsluarm.asciidoc index 2142092c55..af8708b5d4 100644 --- a/docbook/wsluarm.asciidoc +++ b/docbook/wsluarm.asciidoc @@ -43,7 +43,7 @@ initialized and before reading any file. [source,lua] ---- -local p_multi = Proto("multi","MultiProto"); +local p_multi = Proto("multi", "MultiProto"); local vs_protos = { [2] = "mtp2", @@ -55,9 +55,9 @@ local vs_protos = { [8] = "nbap" } -local f_proto = ProtoField.uint8("multi.protocol","Protocol",base.DEC,vs_protos) -local f_dir = ProtoField.uint8("multi.direction","Direction",base.DEC,{ [1] = "incoming", [0] = "outgoing"}) -local f_text = ProtoField.string("multi.text","Text") +local f_proto = ProtoField.uint8("multi.protocol", "Protocol", base.DEC, vs_protos) +local f_dir = ProtoField.uint8("multi.direction", "Direction", base.DEC, { [1] = "incoming", [0] = "outgoing"}) +local f_text = ProtoField.string("multi.text", "Text") p_multi.fields = { f_proto, f_dir, f_text } @@ -76,23 +76,26 @@ local protos = { [11] = DissectorTable.get("ip.proto"):get_dissector(132), -- sctp } -function p_multi.dissector(buf,pkt,root) +function p_multi.dissector(buf, pkt, tree) - local t = root:add(p_multi,buf(0,2)) - t:add(f_proto,buf(0,1)) - t:add(f_dir,buf(1,1)) + local subtree = tree:add(p_multi, buf(0,2)) + subtree:add(f_proto, buf(0,1)) + subtree:add(f_dir, buf(1,1)) local proto_id = buf(0,1):uint() local dissector = protos[proto_id] if dissector ~= nil then - dissector:call(buf(2):tvb(),pkt,root) + -- Dissector was found, invoke subdissector with a new Tvb, + -- created from the current buffer (skipping first two bytes). + dissector:call(buf(2):tvb(), pkt, tree) elseif proto_id < 2 then - t:add(f_text,buf(2)) - -- pkt.cols.info:set(buf(2,buf:len() - 3):string()) + subtree:add(f_text, buf(2)) + -- pkt.cols.info:set(buf(2, buf:len() - 3):string()) else - data_dis:call(buf(2):tvb(),pkt,root) + -- fallback dissector that just shows the raw data. + data_dis:call(buf(2):tvb(), pkt, tree) end end @@ -100,9 +103,9 @@ end local wtap_encap_table = DissectorTable.get("wtap_encap") local udp_encap_table = DissectorTable.get("udp.port") -wtap_encap_table:add(wtap.USER15,p_multi) -wtap_encap_table:add(wtap.USER12,p_multi) -udp_encap_table:add(7555,p_multi) +wtap_encap_table:add(wtap.USER15, p_multi) +wtap_encap_table:add(wtap.USER12, p_multi) +udp_encap_table:add(7555, p_multi) ---- [[wslua_tap_example]] @@ -168,6 +171,27 @@ register_menu("Test/Packets", menuable_tap, MENU_TOOLS_UNSORTED) This Part of the User Guide describes the Wireshark specific functions in the embedded Lua. +Classes group certain functionality, the following notational conventions are +used: + +* 'Class.function()' represents a class method (named 'function') on class + 'Class', taking no arguments. + +* 'Class.function(a)' represents a class method taking one argument. + +* 'Class.function(...)' represents a class method taking a variable number of + arguments. + +* 'class:method()' represents an instance method (named 'method') on an instance + of class 'Class', taking no arguments. Note the lowercase notation in the + documentation to clarify an instance. + +* 'class.prop' represents a property 'prop' on the instance of class 'Class'. + +Trying to access a non-existing property, function or method currently gives an +error, but do not rely on it as the behavior may change in the future. + + include::{build_dir}/wsluarm_src/wslua_dumper.asciidoc[] include::{build_dir}/wsluarm_src/wslua_field.asciidoc[] include::{build_dir}/wsluarm_src/wslua_gui.asciidoc[] |