ui/capture.h

   1 /** @file
   2  *
   3  * Definitions for packet capture windows
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 1998 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later
  10  */
  11
  12 /* This file should only be included if libpcap is present */
  13
  14 #ifndef __CAPTURE_H__
  15 #define __CAPTURE_H__
  16
  17 /** @file
  18  *  Capture related things.
  19  */
  20
  21 #include "capture_opts.h"
  22 #include "capture_info.h"
  23 #include "cfile.h"
  24 #include "capture/capture_session.h"
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif /* __cplusplus */
  29
  30 typedef enum {
  31     capture_cb_capture_prepared,
  32     capture_cb_capture_update_started,
  33     capture_cb_capture_update_continue,
  34     capture_cb_capture_update_finished,
  35     capture_cb_capture_fixed_started,
  36     capture_cb_capture_fixed_continue,
  37     capture_cb_capture_fixed_finished,
  38     capture_cb_capture_stopping,
  39     capture_cb_capture_failed
  40 } capture_cbs;
  41
  42 typedef void (*capture_callback_t) (int event, capture_session *cap_session,
  43                                     void *user_data);
  44
  45 extern void
  46 capture_callback_add(capture_callback_t func, void *user_data);
  47
  48 extern void
  49 capture_callback_remove(capture_callback_t func, void *user_data);
  50
  51 /**
  52  * Initialize a capture session.
  53  *
  54  * @param cap_session the handle for the capture session
  55  * @param cf the capture_file for the file
  56  */
  57 extern void
  58 capture_input_init(capture_session *cap_session, capture_file *cf);
  59
  60 /**
  61  * Start a capture session.
  62  *
  63  * @param capture_opts the numerous capture options
  64  * @param capture_comments if not NULL, a GPtrArray * to a set of comments
  65  *  to put in the capture file's Section Header Block if it's a pcapng file
  66  * @param cap_session the handle for the capture session
  67  * @param cap_data a struct with capture info data
  68  * @param update_cb update screen
  69  * @return true if the capture starts successfully, false otherwise.
  70  */
  71 extern bool
  72 capture_start(capture_options *capture_opts, GPtrArray *capture_comments,
  73               capture_session *cap_session, info_data_t* cap_data,
  74               void(*update_cb)(void));
  75
  76 /** Stop a capture session (usually from a menu item). */
  77 extern void
  78 capture_stop(capture_session *cap_session);
  79
  80 /** Terminate the capture child cleanly when exiting. */
  81 extern void
  82 capture_kill_child(capture_session *cap_session);
  83
  84 struct if_stat_cache_s;
  85 typedef struct if_stat_cache_s if_stat_cache_t;
  86
  87 /**
  88  * Start gathering capture statistics for the interfaces specified.
  89  * @param capture_opts A structure containing options for the capture.
  90  * @return A pointer to the statistics state data.
  91  */
  92 extern WS_RETNONNULL if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
  93
  94 /**
  95  * Retrieve the list of interfaces and their capabilities, and start
  96  * gathering capture statistics for the interfaces.
  97  * @param capture_opts A structure containing options for the capture.
  98  * @param[out] if_list A pointer that will store a GList of if_info_t.
  99  * @return A pointer to the statistics state data.
 100  */
 101 extern WS_RETNONNULL if_stat_cache_t * capture_interface_stat_start(capture_options *capture_opts, GList **if_list);
 102
 103 /**
 104  * Fetch capture statistics, similar to pcap_stats().
 105  */
 106 struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
 107 extern bool capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
 108
 109 /**
 110  * Stop gathering capture statistics.
 111  */
 112 void capture_stat_stop(if_stat_cache_t *sc);
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif /* __cplusplus */
 117
 118 #endif /* capture.h */