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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #endif /* __cplusplus */
32 #include "frame_data.h"
33 #include "column_info.h"
36 typedef struct _epan_dissect_t epan_dissect_t;
38 #include "dfilter/dfilter.h"
41 @mainpage Wireshark EPAN the packet analyzing engine. Source code can be found in the epan directory
53 Ethereal Packet ANalyzer (XXX - is this correct?) the packet analyzing engine. Source code can be found in the epan directory.
55 Protocol-Tree - Keep data of the capture file protocol information.
57 Dissectors - The various protocol dissectors in epan/dissectors.
59 Plugins - Some of the protocol dissectors are implemented as plugins. Source code can be found at plugins.
61 Display-Filters - the display filter engine at epan/dfilter
65 Ref2 for further edits - delete when done
68 This document describes the data structures and the functions exported by the CACE Technologies AirPcap library.
69 The AirPcap library provides low-level access to the AirPcap driver including advanced capabilities such as channel setting,
70 link type control and WEP configuration.<br>
71 This manual includes the following sections:
73 \note throughout this documentation, \e device refers to a physical USB AirPcap device, while \e adapter is an open API
74 instance. Most of the AirPcap API operations are adapter-specific but some of them, like setting the channel, are
75 per-device and will be reflected on all the open adapters. These functions will have "Device" in their name, e.g.
76 AirpcapSetDeviceChannel().
84 /** init the whole epan module, this is used to be called only once in a program */
85 void epan_init(void (*register_all_protocols_func)(register_cb cb, gpointer client_data),
86 void (*register_all_handoffs_func)(register_cb cb, gpointer client_data),
89 void (*report_failure_fcn_p)(const char *, va_list),
90 void (*report_open_failure_fcn_p)(const char *, int, gboolean),
91 void (*report_read_failure_fcn_p)(const char *, int),
92 void (*report_write_failure_fcn_p)(const char *, int));
94 /** cleanup the whole epan module, this is used to be called only once in a program */
95 void epan_cleanup(void);
98 * Initialize the table of conversations. Conversations are identified by
99 * their endpoints; they are used for protocols such as IP, TCP, and UDP,
100 * where packets contain endpoint information but don't contain a single
101 * value indicating to which flow the packet belongs.
103 void epan_conversation_init(void);
104 void epan_conversation_cleanup(void);
107 * Initialize the table of circuits. Circuits are identified by a
108 * circuit ID; they are used for protocols where packets *do* contain
109 * a circuit ID value indicating to which flow the packet belongs.
111 * We might want to make a superclass for both endpoint-specified
112 * conversations and circuit ID-specified circuits, so we can attach
113 * information either to a circuit or a conversation with common
116 void epan_circuit_init(void);
117 void epan_circuit_cleanup(void);
119 /** A client will create one epan_t for an entire dissection session.
120 * A single epan_t will be used to analyze the entire sequence of packets,
121 * sequentially, in a single session. A session corresponds to a single
122 * packet trace file. The reaons epan_t exists is that some packets in
123 * some protocols cannot be decoded without knowledge of previous packets.
124 * This inter-packet "state" is stored in the epan_t.
126 /* XXX - NOTE: epan_t, epan_new and epan_free are currently unused! */
127 typedef struct epan_session epan_t;
136 epan_get_version(void);
138 /** initialize an existing single packet dissection */
140 epan_dissect_init(epan_dissect_t *edt, const gboolean create_proto_tree, const gboolean proto_tree_visible);
142 /** get a new single packet dissection
143 * should be freed using epan_dissect_free() after packet dissection completed
146 epan_dissect_new(const gboolean create_proto_tree, const gboolean proto_tree_visible);
148 /** Indicate whether we should fake protocols or not */
150 epan_dissect_fake_protocols(epan_dissect_t *edt, const gboolean fake_protocols);
152 /** run a single packet dissection */
154 epan_dissect_run(epan_dissect_t *edt, struct wtap_pkthdr *phdr,
155 const guint8* data, frame_data *fd, column_info *cinfo);
157 /** Prime a proto_tree using the fields/protocols used in a dfilter. */
159 epan_dissect_prime_dfilter(epan_dissect_t *edt, const dfilter_t *dfcode);
161 /** fill the dissect run output into the packet list columns */
163 epan_dissect_fill_in_columns(epan_dissect_t *edt, const gboolean fill_col_exprs, const gboolean fill_fd_colums);
165 /** releases resources attached to the packet dissection. DOES NOT free the actual pointer */
167 epan_dissect_cleanup(epan_dissect_t* edt);
169 /** free a single packet dissection */
171 epan_dissect_free(epan_dissect_t* edt);
173 /** Sets custom column */
175 epan_custom_set(epan_dissect_t *edt, int id, gint occurrence,
176 gchar *result, gchar *expr, const int size);
179 * Get compile-time information for libraries used by libwireshark.
182 epan_get_compiled_version_info(GString *str);
185 * Get runtime information for libraries used by libwireshark.
188 epan_get_runtime_version_info(GString *str);
192 #endif /* __cplusplus */