capture_session.h

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