diff options
author | Barbu Paul - Gheorghe <barbu.paul.gheorghe@gmail.com> | 2015-12-29 11:20:49 +0200 |
---|---|---|
committer | Michael Mann <mmann78@netscape.net> | 2015-12-30 00:07:47 +0000 |
commit | cef51084f2f2d5b23cd95a3c3eaa55dfc50fe2b4 (patch) | |
tree | 26fe4af8d091a8e04faa212d01a8f7eb39fd70aa /doc/README.dissector | |
parent | d1b46d9d54ebd2b9217100edc5cf944bdeaca9e1 (diff) |
improved the developer documentation
* tvb_*_length mentioned in README.dissector
* fixed typos in README.dissector
* using stats_tree_register_plugin in the stats_tree examples both in README.stats_tree and the dev guide
* removed the version information and the #endif from the stats tree section in README.dissector
Change-Id: I27df0b5dfd66a7c0ac5b0fe1bdc882b3e9ffda74
Reviewed-on: https://code.wireshark.org/review/12908
Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com>
Reviewed-by: Michael Mann <mmann78@netscape.net>
Diffstat (limited to 'doc/README.dissector')
-rw-r--r-- | doc/README.dissector | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/README.dissector b/doc/README.dissector index 6753483e75..197a985253 100644 --- a/doc/README.dissector +++ b/doc/README.dissector @@ -41,6 +41,7 @@ Laurent Deniel <laurent.deniel[AT]free.fr> Gerald Combs <gerald[AT]wireshark.org> Guy Harris <guy[AT]alum.mit.edu> Ulf Lamping <ulf.lamping[AT]web.de> +Barbu Paul - Gheorghe <barbu.paul.gheorghe[AT]gmail.com> 1. Setting up your protocol dissector code. @@ -405,6 +406,16 @@ Pointer-retrieval: */ guint8* tvb_get_ptr(tvbuff_t *tvb, gint offset, gint length); +Length query: +Get amount of captured data in the buffer (which is *NOT* necessarily the +length of the packet). You probably want tvb_reported_length instead: + + guint tvb_captured_length(const tvbuff_t *tvb); + +Get reported length of buffer: + + guint tvb_reported_length(const tvbuff_t *tvb); + 1.4 Functions to handle columns in the traffic summary window. @@ -2695,7 +2706,7 @@ upon the conversation index and values inside the request packets. NOTE: This sections assumes that all information is available to create a complete conversation, source port/address and destination port/address. If either the destination port or - address is know, see section 2.4 Dynamic server port dissector + address is known, see section 2.4 Dynamic server port dissector registration. For protocols that negotiate a secondary port connection, for example |