Wireshark 4.5.0
The Wireshark network protocol analyzer
Loading...
Searching...
No Matches
capture_session.h
Go to the documentation of this file.
1
12#ifndef __CAPCHILD_CAPTURE_SESSION_H__
13#define __CAPCHILD_CAPTURE_SESSION_H__
14
15#ifndef _WIN32
16#include <sys/types.h>
17#include <stdint.h>
18#endif
19
20#include "capture_opts.h"
21
22#include <epan/fifo_string_cache.h>
23#include <wsutil/processes.h>
24
25#include "cfile.h"
26
27#ifdef __cplusplus
28extern "C" {
29#endif /* __cplusplus */
30
31#ifdef HAVE_LIBPCAP
32/* Current state of capture engine. XXX - differentiate states */
33typedef enum {
34 CAPTURE_STOPPED,
35 CAPTURE_PREPARING,
36 CAPTURE_RUNNING
37} capture_state;
38
39struct _info_data;
40
41/*
42 * State of a capture session.
43 */
45
46/*
47 * Types of callbacks.
48 */
49
53typedef bool (*new_file_fn)(capture_session *cap_session, char *new_file);
54
58typedef void (*new_packets_fn)(capture_session *cap_session, int to_read);
59
63typedef void (*drops_fn)(capture_session *cap_session, uint32_t dropped,
64 const char *interface_name);
65
70typedef void (*error_fn)(capture_session *cap_session, char *error_msg,
71 char *secondary_error_msg);
72
77typedef void (*cfilter_error_fn)(capture_session *cap_session, unsigned i,
78 const char *error_message);
79
84typedef void (*closed_fn)(capture_session *cap_session, char *msg);
85
86/*
87 * The structure for the session.
88 */
89struct _capture_session {
90 ws_process_id fork_child;
91 int fork_child_status;
92 int pipe_input_id;
93#ifdef _WIN32
94 int signal_pipe_write_fd;
95#endif
96 capture_state state;
97#ifndef _WIN32
98 uid_t owner;
99 gid_t group;
100#endif
101 bool session_will_restart;
102 uint64_t count;
103 uint32_t count_pending;
104 capture_options *capture_opts;
105 capture_file *cf;
106 wtap_rec rec;
107 Buffer buf;
108 struct wtap *wtap;
109 struct _info_data *cap_data_info;
111 // If the user wants to ignore duplicate frames, we need these.
112 fifo_string_cache_t frame_dup_cache;
113 GChecksum *frame_cksum;
114
115 /*
116 * Routines supplied by our caller; we call them back to notify them
117 * of various events.
118 */
119 new_file_fn new_file;
120 new_packets_fn new_packets;
121 drops_fn drops;
122 error_fn error;
123 cfilter_error_fn cfilter_error;
124 closed_fn closed;
125};
126
127extern void
128capture_session_init(capture_session *cap_session, capture_file *cf,
129 new_file_fn new_file, new_packets_fn new_packets,
130 drops_fn drops, error_fn error,
131 cfilter_error_fn cfilter_error, closed_fn closed);
132
133void capture_process_finished(capture_session *cap_session);
134#else
135
136/* dummy is needed because clang throws the error: empty struct has size 0 in C, size 1 in C++ */
137typedef struct _capture_session {int dummy;} capture_session;
138
139#endif /* HAVE_LIBPCAP */
140
141#ifdef __cplusplus
142}
143#endif /* __cplusplus */
144
145#endif /* __CAPCHILD_CAPTURE_SESSION_H__ */
Definition cfile.h:67
Definition capture_session.h:137
Definition capture_info.h:40
Definition buffer.h:22
Definition capture_opts.h:248
Definition fifo_string_cache.h:24
Definition wtap.h:1432
Definition wtap-int.h:37