capture_session.h

   1 /* capture_session.h
   2  * State of a capture session
   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 #ifndef __CAPTURE_SESSION_H__
  26 #define __CAPTURE_SESSION_H__
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /* Current state of capture engine. XXX - differentiate states */
  33 typedef enum {
  34     CAPTURE_STOPPED,        /**< stopped */
  35     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
  36     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
  37 } capture_state;
  38
  39 /*
  40  * State of a capture session.
  41  */
  42 typedef struct {
  43     int fork_child;                 /**< If not -1, in parent, process ID of child */
  44     int fork_child_status;          /**< Child exit status */
  45 #ifdef _WIN32
  46     int signal_pipe_write_fd;       /**< the pipe to signal the child */
  47 #endif
  48     capture_state state;            /**< current state of the capture engine */
  49 #ifndef _WIN32
  50     uid_t owner;                    /**< owner of the cfile */
  51     gid_t group;                    /**< group of the cfile */
  52 #endif
  53     gboolean session_started;
  54     capture_options *capture_opts;  /**< options for this capture */
  55     void *cf;                       /**< handle to cfile (note: untyped handle) */
  56 } capture_session;
  57
  58 extern void
  59 capture_session_init(capture_session *cap_session, void *cf);
  60
  61 #ifdef __cplusplus
  62 }
  63 #endif /* __cplusplus */
  64
  65 #endif /* __CAPTURE_SESSION_H__ */