epan/circuit.h

   1 /* circuit.h
   2  * Routines for building lists of packets that are part of a "circuit"
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #ifndef __CIRCUIT_H__
  26 #define __CIRCUIT_H__
  27
  28 #include "packet.h"             /* for circuit dissector type */
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif /* __cplusplus */
  33
  34 /*
  35  * Data structure representing a circuit.
  36  */
  37 typedef struct circuit_key {
  38         circuit_type ctype;
  39         guint32 circuit_id;
  40 } circuit_key;
  41
  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;
  49                                         /* handle for protocol dissector client associated with circuit */
  50         guint   options;                /* wildcard flags */
  51         circuit_key *key_ptr;           /* pointer to the key for this circuit */
  52 } circuit_t;
  53
  54 extern void circuit_cleanup(void);
  55 extern void circuit_init(void);
  56
  57 extern circuit_t *circuit_new(circuit_type ctype, guint32 circuit_id,
  58     guint32 first_frame);
  59
  60 extern circuit_t *find_circuit(circuit_type ctype, guint32 circuit_id,
  61     guint32 frame);
  62
  63 extern void close_circuit(circuit_t *circuit, guint32 last_frame);
  64
  65 extern void circuit_add_proto_data(circuit_t *conv, int proto,
  66     void *proto_data);
  67 extern void *circuit_get_proto_data(circuit_t *conv, int proto);
  68 extern void circuit_delete_proto_data(circuit_t *conv, int proto);
  69
  70 extern void circuit_set_dissector(circuit_t *circuit,
  71     dissector_handle_t handle);
  72 extern dissector_handle_t circuit_get_dissector(circuit_t *circuit);
  73 extern gboolean
  74 try_circuit_dissector(circuit_type ctype, guint32 circuit_id, guint32 frame,
  75    tvbuff_t *tvb,  packet_info *pinfo, proto_tree *tree);
  76
  77 #ifdef __cplusplus
  78 }
  79 #endif /* __cplusplus */
  80
  81 #endif /* circuit.h */