summaryrefslogtreecommitdiffstats
path: root/ui/capture.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 20:34:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 20:34:10 +0000
commite4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc (patch)
tree68cb5ef9081156392f1dd62a00c6ccc1451b93df /ui/capture.h
parentInitial commit. (diff)
downloadwireshark-e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc.tar.xz
wireshark-e4ba6dbc3f1e76890b22773807ea37fe8fa2b1bc.zip
Adding upstream version 4.2.2.upstream/4.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ui/capture.h')
-rw-r--r--ui/capture.h109
1 files changed, 109 insertions, 0 deletions
diff --git a/ui/capture.h b/ui/capture.h
new file mode 100644
index 00000000..d1ec3aee
--- /dev/null
+++ b/ui/capture.h
@@ -0,0 +1,109 @@
+/** @file
+ *
+ * Definitions for packet capture windows
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+/* This file should only be included if libpcap is present */
+
+#ifndef __CAPTURE_H__
+#define __CAPTURE_H__
+
+/** @file
+ * Capture related things.
+ */
+
+#include "capture_opts.h"
+#include "capture_info.h"
+#include "cfile.h"
+#include "capture/capture_session.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+typedef enum {
+ capture_cb_capture_prepared,
+ capture_cb_capture_update_started,
+ capture_cb_capture_update_continue,
+ capture_cb_capture_update_finished,
+ capture_cb_capture_fixed_started,
+ capture_cb_capture_fixed_continue,
+ capture_cb_capture_fixed_finished,
+ capture_cb_capture_stopping,
+ capture_cb_capture_failed
+} capture_cbs;
+
+typedef void (*capture_callback_t) (gint event, capture_session *cap_session,
+ gpointer user_data);
+
+extern void
+capture_callback_add(capture_callback_t func, gpointer user_data);
+
+extern void
+capture_callback_remove(capture_callback_t func, gpointer user_data);
+
+/**
+ * Initialize a capture session.
+ *
+ * @param cap_session the handle for the capture session
+ * @param cf the capture_file for the file
+ */
+extern void
+capture_input_init(capture_session *cap_session, capture_file *cf);
+
+/**
+ * Start a capture session.
+ *
+ * @param capture_opts the numerous capture options
+ * @param capture_comments if not NULL, a GPtrArray * to a set of comments
+ * to put in the capture file's Section Header Block if it's a pcapng file
+ * @param cap_session the handle for the capture session
+ * @param cap_data a struct with capture info data
+ * @param update_cb update screen
+ * @return TRUE if the capture starts successfully, FALSE otherwise.
+ */
+extern gboolean
+capture_start(capture_options *capture_opts, GPtrArray *capture_comments,
+ capture_session *cap_session, info_data_t* cap_data,
+ void(*update_cb)(void));
+
+/** Stop a capture session (usually from a menu item). */
+extern void
+capture_stop(capture_session *cap_session);
+
+/** Terminate the capture child cleanly when exiting. */
+extern void
+capture_kill_child(capture_session *cap_session);
+
+struct if_stat_cache_s;
+typedef struct if_stat_cache_s if_stat_cache_t;
+
+/**
+ * Start gathering capture statistics for the interfaces specified.
+ * @param capture_opts A structure containing options for the capture.
+ * @return A pointer to the statistics state data.
+ */
+extern WS_RETNONNULL if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
+
+/**
+ * Fetch capture statistics, similar to pcap_stats().
+ */
+struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
+extern gboolean capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
+
+/**
+ * Stop gathering capture statistics.
+ */
+void capture_stat_stop(if_stat_cache_t *sc);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* capture.h */