osmocom
/
wireshark
14
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

add details for doxygen 

svn path=/trunk/; revision=11127
This commit is contained in:
Ulf Lamping 2004-06-08 05:42:57 +00:00
parent c16562407d
commit 6aba0658ee
1 changed files with 37 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
epan/packet.h
View File

@ -1,7 +1,7 @@
/* packet.h /* packet.h
* Definitions for packet disassembly structures and routines * Definitions for packet disassembly structures and routines
* *
* $Id: packet.h,v 1.72 2003/10/01 07:11:45 guy Exp $ * $Id: packet.h,v 1.73 2004/06/08 05:42:57 ulfl Exp $
* *
* Ethereal - Network traffic analyzer * Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@ethereal.com> * By Gerald Combs <gerald@ethereal.com>
@ -220,25 +220,48 @@ extern void dissector_add_handle(const char *name, dissector_handle_t handle);
by another dissector. */ by another dissector. */
typedef GSList *heur_dissector_list_t; typedef GSList *heur_dissector_list_t;
/* Type of a heuristic dissector */ /** A protocol uses this function to register a heuristic sub-dissector list.
typedef gboolean (*heur_dissector_t)(tvbuff_t *, packet_info *, * Call this in the parent dissectors proto_register function.
proto_tree *); *
* @param name the name of this protocol
/* A protocol uses this function to register a heuristic dissector list */ * @param list the list of heuristic sub-dissectors to be registered
*/
extern void register_heur_dissector_list(const char *name, extern void register_heur_dissector_list(const char *name,
heur_dissector_list_t *list); heur_dissector_list_t *list);
/* Add a sub-dissector to a heuristic dissector list. Called by the /** Try all the dissectors in a given heuristic dissector list. This is done,
protocol routine that wants to register a sub-dissector. */ * until we find one that recognizes the protocol.
extern void heur_dissector_add(const char *name, heur_dissector_t dissector, * Call this while the parent dissector running.
int proto); *
* @param sub_dissectors the sub-dissector list
/* Try all the dissectors in a given heuristic dissector list until * @param tvb the tv_buff with the (remaining) packet data
we find one that recognizes the protocol, in which case we return * @param pinfo the packet info of this packet (additional info)
TRUE, or we run out of dissectors, in which case we return FALSE. */ * @param tree the protocol tree to be build or NULL
* @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
*/
extern gboolean dissector_try_heuristic(heur_dissector_list_t sub_dissectors, extern gboolean dissector_try_heuristic(heur_dissector_list_t sub_dissectors,
tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree); tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
/** Type of a heuristic dissector, used in heur_dissector_add().
*
* @param tvb the tv_buff with the (remaining) packet data
* @param pinfo the packet info of this packet (additional info)
* @param tree the protocol tree to be build or NULL
* @return TRUE if the packet was recognized by the sub-dissector (stop dissection here)
*/
typedef gboolean (*heur_dissector_t)(tvbuff_t *tvb, packet_info *pinfo,
proto_tree *tree);
/** Add a sub-dissector to a heuristic dissector list.
* Call this in the proto_handoff function of the sub-dissector.
*
* @param name the name of the "parent" protocol, e.g. "tcp"
* @param dissector the sub-dissector to be registered
* @param proto the protocol id of the sub-dissector
*/
extern void heur_dissector_add(const char *name, heur_dissector_t dissector,
int proto);
/* Register a dissector. */ /* Register a dissector. */
extern void register_dissector(const char *name, dissector_t dissector, extern void register_dissector(const char *name, dissector_t dissector,
int proto); int proto);