capchild/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 __CAPCHILD_CAPTURE_SESSION_H__
  24 #define __CAPCHILD_CAPTURE_SESSION_H__
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif /* __cplusplus */
  29
  30 #ifndef _WIN32
  31 #include <sys/types.h>
  32 #include <stdint.h>
  33 #endif
  34
  35 #include "capture_opts.h"
  36
  37 #include <wsutil/processes.h>
  38
  39 #ifdef HAVE_LIBPCAP
  40 /* Current state of capture engine. XXX - differentiate states */
  41 typedef enum {
  42     CAPTURE_STOPPED,        /**< stopped */
  43     CAPTURE_PREPARING,      /**< preparing, but still no response from capture child */
  44     CAPTURE_RUNNING         /**< capture child signalled ok, capture is running now */
  45 } capture_state;
  46
  47 struct _capture_file;
  48 struct _info_data;
  49 /*
  50  * State of a capture session.
  51  */
  52 typedef struct _capture_session {
  53     ws_process_id fork_child;             /**< If not -1, in parent, process ID of child */
  54     int       fork_child_status;          /**< Child exit status */
  55 #ifdef _WIN32
  56     int       signal_pipe_write_fd;       /**< the pipe to signal the child */
  57 #endif
  58     capture_state state;                  /**< current state of the capture engine */
  59 #ifndef _WIN32
  60     uid_t     owner;                      /**< owner of the cfile */
  61     gid_t     group;                      /**< group of the cfile */
  62 #endif
  63     gboolean  session_started;
  64     guint32   count;                      /**< Total number of frames captured */
  65     capture_options *capture_opts;        /**< options for this capture */
  66     struct    _capture_file *cf;          /**< handle to cfile */
  67     struct _info_data *cap_data_info;          /**< stats for this capture */
  68 } capture_session;
  69
  70 extern void
  71 capture_session_init(capture_session *cap_session, struct _capture_file *cf);
  72 #else
  73
  74 /* dummy is needed because clang throws the error: empty struct has size 0 in C, size 1 in C++ */
  75 typedef struct _capture_session {int dummy;} capture_session;
  76
  77 #endif /* HAVE_LIBPCAP */
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif /* __cplusplus */
  82
  83 #endif /* __CAPCHILD_CAPTURE_SESSION_H__ */