capture.h

   1 /* capture.h
   2  * Definitions for packet capture windows
   3  *
   4  * Wireshark - Network traffic analyzer
   5  * By Gerald Combs <gerald@wireshark.org>
   6  * Copyright 1998 Gerald Combs
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 /* This file should only be included if libpcap is present */
  24
  25 #ifndef __CAPTURE_H__
  26 #define __CAPTURE_H__
  27
  28 /** @file
  29  *  Capture related things.
  30  */
  31
  32 #include "capture_opts.h"
  33 #include "capture_session.h"
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39 typedef enum {
  40     capture_cb_capture_prepared,
  41     capture_cb_capture_update_started,
  42     capture_cb_capture_update_continue,
  43     capture_cb_capture_update_finished,
  44     capture_cb_capture_fixed_started,
  45     capture_cb_capture_fixed_continue,
  46     capture_cb_capture_fixed_finished,
  47     capture_cb_capture_stopping,
  48     capture_cb_capture_failed
  49 } capture_cbs;
  50
  51 typedef void (*capture_callback_t) (gint event, capture_session *cap_session,
  52                                     gpointer user_data);
  53
  54 extern void
  55 capture_callback_add(capture_callback_t func, gpointer user_data);
  56
  57 extern void
  58 capture_callback_remove(capture_callback_t func);
  59
  60 /**
  61  * Start a capture session.
  62  *
  63  * @param capture_opts the numerous capture options
  64  * @param cap_session a handle for the capture session
  65  * @param update_cb update screen
  66  * @return TRUE if the capture starts successfully, FALSE otherwise.
  67  */
  68 extern gboolean
  69 capture_start(capture_options *capture_opts, capture_session *cap_session, void(*update_cb)(void));
  70
  71 /** Stop a capture session (usually from a menu item). */
  72 extern void
  73 capture_stop(capture_session *cap_session);
  74
  75 /** Restart the current captured packets and start again. */
  76 extern void
  77 capture_restart(capture_session *cap_session);
  78
  79 /** Terminate the capture child cleanly when exiting. */
  80 extern void
  81 capture_kill_child(capture_session *cap_session);
  82
  83 struct if_stat_cache_s;
  84 typedef struct if_stat_cache_s if_stat_cache_t;
  85
  86 /**
  87  * Start gathering capture statistics for the interfaces specified.
  88  * @param capture_opts A structure containing options for the capture.
  89  * @return A pointer to the statistics state data.
  90  */
  91 extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
  92
  93 /**
  94  * Fetch capture statistics, similar to pcap_stats().
  95  */
  96 struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
  97 extern gboolean capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
  98
  99 /**
 100  * Stop gathering capture statistics.
 101  */
 102 void capture_stat_stop(if_stat_cache_t *sc);
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif /* __cplusplus */
 107
 108 #endif /* capture.h */