capture_sync.h

   1 /* capture_sync.h
   2  * Synchronisation between Wireshark capture parent and child instances
   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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  23  */
  24
  25
  26 /** @file
  27  *
  28  *  Sync mode capture (internal interface).
  29  *
  30  *  Will start a new Wireshark child instance which will do the actual capture
  31  *  work.
  32  */
  33
  34 #ifndef __CAPTURE_SYNC_H__
  35 #define __CAPTURE_SYNC_H__
  36
  37 /**
  38  * Start a new capture session.
  39  *  Create a capture child which is doing the real capture work.
  40  *  The various capture_input_... functions will be called, if something had
  41  *  happened.
  42  *
  43  *  Most of the parameters are passed through the global capture_opts.
  44  *
  45  *  @param capture_opts the options
  46  *  @param cap_session a handle for the capture session
  47  *  @return             TRUE if a capture could be started, FALSE if not
  48  */
  49 extern gboolean
  50 sync_pipe_start(capture_options *capture_opts, capture_session *cap_session, void(*update_cb)(void));
  51
  52 /** User wants to stop capturing, gracefully close the capture child */
  53 extern void
  54 sync_pipe_stop(capture_session *cap_session);
  55
  56 /** User wants to stop the program, just kill the child as soon as possible */
  57 extern void
  58 sync_pipe_kill(int fork_child);
  59
  60 /** Set wireless channel using dumpcap */
  61 extern int
  62 sync_interface_set_80211_chan(const gchar *iface, const char *freq, const gchar *type,
  63                               gchar **data, gchar **primary_msg,
  64                               gchar **secondary_msg, void (*update_cb)(void));
  65
  66 /** Get an interface list using dumpcap */
  67 extern int
  68 sync_interface_list_open(gchar **data, gchar **primary_msg,
  69                          gchar **secondary_msg, void (*update_cb)(void));
  70
  71 /** Get interface capabilities using dumpcap */
  72 extern int
  73 sync_if_capabilities_open(const gchar *ifname, gboolean monitor_mode,
  74                           gchar **data, gchar **primary_msg,
  75                           gchar **secondary_msg, void (*update_cb)(void));
  76
  77 /** Start getting interface statistics using dumpcap. */
  78 extern int
  79 sync_interface_stats_open(int *read_fd, int *fork_child, gchar **msg, void (*update_cb)(void));
  80
  81 /** Stop gathering statistics. */
  82 extern int
  83 sync_interface_stats_close(int *read_fd, int *fork_child, gchar **msg);
  84
  85 /** Read a line from a pipe, similar to fgets.  Non-blocking. */
  86 extern int
  87 sync_pipe_gets_nonblock(int pipe_fd, char *bytes, int max);
  88
  89 /*
  90  * Routines supplied by our caller; we call them back to notify them
  91  * of various events.
  92  *
  93  * XXX - this is *really* ugly.  We should do this better.
  94  */
  95
  96 /**
  97  * Capture child told us we have a new (or the first) capture file.
  98  */
  99 extern gboolean
 100 capture_input_new_file(capture_session *cap_session, gchar *new_file);
 101
 102 /**
 103  * Capture child told us we have new packets to read.
 104  */
 105 extern void
 106 capture_input_new_packets(capture_session *cap_session, int to_read);
 107
 108 /**
 109  * Capture child told us how many dropped packets it counted.
 110  */
 111 extern void
 112 capture_input_drops(capture_session *cap_session, guint32 dropped);
 113
 114 /**
 115  * Capture child told us that an error has occurred while starting the capture.
 116  */
 117 extern void
 118 capture_input_error_message(capture_session *cap_session, char *error_message,
 119                             char *secondary_error_msg);
 120
 121 /**
 122  * Capture child told us that an error has occurred while parsing a
 123  * capture filter when starting/running the capture.
 124  */
 125 extern void
 126 capture_input_cfilter_error_message(capture_session *cap_session, guint i,
 127                                     char *error_message);
 128
 129 /**
 130  * Capture child closed its side of the pipe, report any error and
 131  * do the required cleanup.
 132  */
 133 extern void
 134 capture_input_closed(capture_session *cap_session, gchar *msg);
 135
 136 /* set a callback to be called after fork with the pid of the forked child */
 137 extern void capture_sync_set_fetch_dumpcap_pid_cb(void(*cb)(int pid));
 138
 139 #endif /* capture_sync.h */