epan/tap.h

   1 /* tap.h
   2  * packet tap interface   2002 Ronnie Sahlberg
   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 _TAP_H_
  26 #define _TAP_H_
  27
  28 #include <epan/epan.h>
  29
  30 typedef void (*tap_reset_cb)(void *tapdata);
  31 typedef gboolean (*tap_packet_cb)(void *tapdata, packet_info *pinfo, epan_dissect_t *edt, const void *data);
  32 typedef void (*tap_draw_cb)(void *tapdata);
  33
  34 /*
  35  * Flags to indicate what a tap listener's packet routine requires.
  36  */
  37 #define TL_REQUIRES_NOTHING     0x00000000      /**< nothing */
  38 #define TL_REQUIRES_PROTO_TREE  0x00000001      /**< full protocol tree */
  39 #define TL_REQUIRES_COLUMNS     0x00000002      /**< columns */
  40 /* Flags to indicate what the tap listener does */
  41 #define TL_IS_DISSECTOR_HELPER  0x00000004      /** tap helps a dissector do work
  42                                                  ** but does not, itself, require dissection */
  43
  44 extern void tap_init(void);
  45 extern int register_tap(const char *name);
  46 extern int find_tap_id(const char *name);
  47 extern void tap_queue_packet(int tap_id, packet_info *pinfo, const void *tap_specific_data);
  48 extern void tap_build_interesting(epan_dissect_t *edt);
  49 extern void tap_queue_init(epan_dissect_t *edt);
  50 extern void tap_push_tapped_queue(epan_dissect_t *edt);
  51 extern void reset_tap_listeners(void);
  52 extern void draw_tap_listeners(gboolean draw_all);
  53 extern GString *register_tap_listener(const char *tapname, void *tapdata,
  54     const char *fstring, guint flags, tap_reset_cb tap_reset,
  55     tap_packet_cb tap_packet, tap_draw_cb tap_draw);
  56 extern GString *set_tap_dfilter(void *tapdata, const char *fstring);
  57 extern void remove_tap_listener(void *tapdata);
  58 extern gboolean tap_listeners_require_dissection(void);
  59 extern gboolean have_tap_listener(int tap_id);
  60 extern gboolean have_filtering_tap_listeners(void);
  61 extern guint union_of_tap_listener_flags(void);
  62 extern const void *fetch_tapped_data(int tap_id, int idx);
  63
  64 #endif