Correct comments and examples on get_pdu_len().
authorjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Tue, 21 Nov 2006 14:18:46 +0000 (14:18 +0000)
committerjake <jake@f5534014-38df-0310-8fa8-9805f1628bb7>
Tue, 21 Nov 2006 14:18:46 +0000 (14:18 +0000)
git-svn-id: http://anonsvn.wireshark.org/wireshark/trunk@19949 f5534014-38df-0310-8fa8-9805f1628bb7

doc/README.developer
docbook/wsdg_src/WSDG_chapter_dissection.xml
epan/dissectors/packet-tcp.c
epan/dissectors/packet-tcp.h

index 045eb9fd2f437c83f88f71b71c6446ee4e94bf98..4869b4d9ac2cdd609b8e5a4b9cff0d40a537509d 100644 (file)
@@ -3120,12 +3120,12 @@ The arguments to tcp_dissect_pdus are:
        the number of bytes of PDU data required to determine the length
        of the PDU;
 
-       a routine that takes as arguments a tvbuff pointer and an offset
-       value representing the offset into the tvbuff at which a PDU
-       begins and should return - *without* throwing an exception (it
-       is guaranteed that the number of bytes specified by the previous
-       argument to tcp_dissect_pdus is available, but more data might
-       not be available, so don't refer to any data past that) - the
+       a routine that takes as arguments a packet_info pointer, a tvbuff
+       pointer and an offset value representing the offset into the tvbuff
+       at which a PDU begins and should return - *without* throwing an
+       exception (it is guaranteed that the number of bytes specified by the
+       previous argument to tcp_dissect_pdus is available, but more data
+       might not be available, so don't refer to any data past that) - the
        total length of the PDU, in bytes;
 
        a routine that's passed a tvbuff pointer, packet_info pointer,
index 0389508b43e47af21ee06db605b9a3ca77363c6c..6ccc3bbd58b0870a95fad2daf1eaa67f21e67744 100644 (file)
@@ -536,9 +536,10 @@ static const value_string packettypenames[] = {
    <programlisting>
    <![CDATA[
        { &hf_foo_pdu_type,
-       { "FOO PDU Type",           "foo.type",
-       FT_UINT8, BASE_DEC, VALS(packettypenames), 0x0,
-       "", HFILL }
+               { "FOO PDU Type", "foo.type",
+               FT_UINT8, BASE_DEC,
+               VALS(packettypenames), 0x0,
+               NULL, HFILL }
        },
 ]]>    
    </programlisting></example>
@@ -558,19 +559,22 @@ static int hf_foo_endflag = -1;
 static int hf_foo_priorityflag = -1;
 ...
        { &hf_foo_startflag,
-       { "FOO PDU Start Flags",           "foo.flags.start",
-       FT_BOOLEAN, 8, NULL, FOO_START_FLAG,
-       "", HFILL }
+               { "FOO PDU Start Flags", "foo.flags.start",
+               FT_BOOLEAN, 8, 
+               NULL, FOO_START_FLAG,
+               NULL, HFILL }
        },
        { &hf_foo_endflag,
-       { "FOO PDU End Flags",           "foo.flags.end",
-       FT_BOOLEAN, 8, NULL, FOO_END_FLAG,
-       "", HFILL }
+               { "FOO PDU End Flags", "foo.flags.end",
+               FT_BOOLEAN, 8,
+               NULL, FOO_END_FLAG,
+               NULL, HFILL }
        },
        { &hf_foo_priorityflag,
-       { "FOO PDU Priority Flags",           "foo.flags.priority",
-       FT_BOOLEAN, 8, NULL, FOO_PRIORITY_FLAG,
-       "", HFILL }
+               { "FOO PDU Priority Flags", "foo.flags.priority",
+               FT_BOOLEAN, 8, 
+               NULL, FOO_PRIORITY_FLAG,
+               NULL, HFILL }
        },
 ...
        proto_tree_add_item(foo_tree, hf_foo_flags, tvb, offset, 1, FALSE);
@@ -1038,7 +1042,7 @@ static void dissect_foo_message(tvbuff_t *tvb, packet_info *pinfo, proto_tree *t
 }
 
 /* determine PDU length of protocol foo */
-static guint get_foo_message_len(tvbuff_t *tvb, int offset)
+static guint get_foo_message_len(packet_info *pinfo, tvbuff_t *tvb, int offset)
 {
     /* TODO: change this to your needs */
     return (guint)tvb_get_ntohl(tvb, offset+4); /* e.g. length is at offset 4 */
index 7f8538b0cf35ba05f88d9219c73a2859acda0a27..0fab68f10e035c104bc32994f770d6fbcf886867 100644 (file)
@@ -1462,7 +1462,7 @@ again:
  * "fixed_len" is the length of the fixed-length part of the PDU.
  *
  * "get_pdu_len()" is a routine called to get the length of the PDU from
- * the fixed-length part of the PDU; it's passed "tvb" and "offset".
+ * the fixed-length part of the PDU; it's passed "pinfo", "tvb" and "offset".
  *
  * "dissect_pdu()" is the routine to dissect a PDU.
  */
index 911f565f0a9d32d2eee7c67076cad4770c7cf04f..1a282b2f9555e3075638efe01e063324dfad59e2 100644 (file)
@@ -76,7 +76,7 @@ struct tcpinfo {
  * "fixed_len" is the length of the fixed-length part of the PDU.
  *
  * "get_pdu_len()" is a routine called to get the length of the PDU from
- * the fixed-length part of the PDU; it's passed "tvb" and "offset".
+ * the fixed-length part of the PDU; it's passed "pinfo", "tvb" and "offset".
  *
  * "dissect_pdu()" is the routine to dissect a PDU.
  */