2 * Routines for building lists of packets that are part of a "circuit"
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
28 #include "packet.h" /* for circuit dissector type */
32 #endif /* __cplusplus */
35 * Data structure representing a circuit.
37 typedef struct circuit_key {
42 typedef struct circuit {
43 struct circuit *next; /**< pointer to next circuit with given circuit ID */
44 guint32 first_frame; /**< # of first frame for that circuit */
45 guint32 last_frame; /**< # of last frame for that circuit */
46 guint32 index; /**< unique ID for circuit */
47 GSList *data_list; /**< list of data associated with circuit */
48 dissector_handle_t dissector_handle; /**< handle for protocol dissector client associated with circuit */
49 guint options; /**< wildcard flags */
50 circuit_key *key_ptr; /**< pointer to the key for this circuit */
54 * Destroy all existing circuits.
56 extern void circuit_cleanup(void);
59 * Initialize some variables every time a file is loaded or re-loaded.
60 * Create a new hash table for the circuits in the new file.
62 extern void circuit_init(void);
65 * Given a circuit type and circuit ID for a packet, create a new circuit
66 * to contain packets for that circuit.
68 extern circuit_t *circuit_new(circuit_type ctype, guint32 circuit_id,
72 * Given a circuit type and ID, and a frame number, search for a circuit with
73 * that type and ID whose range of frames includes that frame number.
74 * Returns NULL if not found.
76 extern circuit_t *find_circuit(circuit_type ctype, guint32 circuit_id,
80 * Set the last frame of a circuit, if it's not already known,
81 * "closing" the circuit.
83 extern void close_circuit(circuit_t *circuit, guint32 last_frame);
85 extern void circuit_add_proto_data(circuit_t *conv, int proto,
87 extern void *circuit_get_proto_data(circuit_t *conv, int proto);
88 extern void circuit_delete_proto_data(circuit_t *conv, int proto);
90 extern void circuit_set_dissector(circuit_t *circuit,
91 dissector_handle_t handle);
92 extern dissector_handle_t circuit_get_dissector(circuit_t *circuit);
95 * Given a circuit type and ID for a packet, search for a matching
96 * circuit and, if found and it has a circuit dissector,
97 * call that dissector and return TRUE, otherwise return FALSE.
100 try_circuit_dissector(circuit_type ctype, guint32 circuit_id, guint32 frame,
101 tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
105 #endif /* __cplusplus */
107 #endif /* circuit.h */