capture_sync.h

   1 /* capture_sync.h
   2  * Synchronisation between Ethereal capture parent and child instances
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   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
  26 /** @file
  27  *
  28  *  Sync mode capture (internal interface).
  29  *
  30  *  Will start a new Ethereal 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  *  @return             TRUE if a capture could be started, FALSE if not
  47  */
  48 extern gboolean
  49 sync_pipe_start(capture_options *capture_opts);
  50
  51 /** User wants to stop capturing, gracefully close the capture child */
  52 extern void
  53 sync_pipe_stop(capture_options *capture_opts);
  54
  55 /** User wants to stop the program, just kill the child as soon as possible */
  56 extern void
  57 sync_pipe_kill(capture_options *capture_opts);
  58
  59
  60 /** the child has opened a new capture file, notify the parent */
  61 extern void
  62 sync_pipe_filename_to_parent(const char *filename);
  63
  64 /** the child captured some new packets, notify the parent */
  65 extern void
  66 sync_pipe_packet_count_to_parent(int packet_count);
  67
  68 /** the child stopped capturing, notify the parent */
  69 extern void
  70 sync_pipe_drops_to_parent(int drops);
  71
  72 /** the child encountered an error, notify the parent */
  73 extern void
  74 sync_pipe_errmsg_to_parent(const char *errmsg);
  75
  76
  77 #endif /* capture_sync.h */