5 * Wireshark Protocol Analyzer Library
7 * Copyright (c) 2001 by Gerald Combs <gerald@wireshark.org>
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 #include "frame_data.h"
29 #include "column_info.h"
32 typedef struct _epan_dissect_t epan_dissect_t;
34 #include "dfilter/dfilter.h"
36 /* init the whole epan module, this is used to be called only once in a program */
37 void epan_init(void (*register_all_protocols_func)(register_cb cb, gpointer client_data),
38 void (*register_all_handoffs_func)(register_cb cb, gpointer client_data),
41 void (*report_failure)(const char *, va_list),
42 void (*report_open_failure)(const char *, int, gboolean),
43 void (*report_read_failure)(const char *, int),
44 void (*report_write_failure)(const char *, int));
46 /* cleanup the whole epan module, this is used to be called only once in a program */
47 void epan_cleanup(void);
49 /* Initialize the table of conversations. */
50 void epan_conversation_init(void);
52 /* Initialize the table of circuits. */
53 /* XXX - what is a circuit and should this better be combined with epan_conversation_init? */
54 void epan_circuit_init(void);
56 /* A client will create one epan_t for an entire dissection session.
57 * A single epan_t will be used to analyze the entire sequence of packets,
58 * sequentially, in a single session. A session corresponds to a single
59 * packet trace file. The reaons epan_t exists is that some packets in
60 * some protocols cannot be decoded without knowledge of previous packets.
61 * This inter-packet "state" is stored in the epan_t.
63 /* XXX - NOTE: epan_t, epan_new and epan_free are currently unused! */
64 typedef struct epan_session epan_t;
73 epan_get_version(void);
75 /* get a new single packet dissection */
76 /* should be freed using epan_dissect_free() after packet dissection completed */
78 epan_dissect_new(gboolean create_proto_tree, gboolean proto_tree_visible);
80 /* run a single packet dissection */
82 epan_dissect_run(epan_dissect_t *edt, void* pseudo_header,
83 const guint8* data, frame_data *fd, column_info *cinfo);
85 /* Prime a proto_tree using the fields/protocols used in a dfilter. */
87 epan_dissect_prime_dfilter(epan_dissect_t *edt, const dfilter_t *dfcode);
89 /* fill the dissect run output into the packet list columns */
91 epan_dissect_fill_in_columns(epan_dissect_t *edt);
93 /* free a single packet dissection */
95 epan_dissect_free(epan_dissect_t* edt);